Add Vasa Provider

Add a VASA Provider

Request

URI

POST

https://{api_host}/v1/vasa-providers

COPY

Request Body

VasaProvider of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "url": "string",
    "storageContainers": [
        {
            "name": "string",
            "protocolType": "One among: ISCSI, FC, NFS"
        }
    ],
    "users": [
        {
            "username": "string",
            "password": "string"
        }
    ]
}

{
    "id": "string",
    "name": "string",
    "url": "string",
    "storageContainers": [
        {
            "id": "string",
            "name": "string",
            "protocolType": "One among: ISCSI, FC, NFS",
            "clusterId": "string"
        }
    ],
    "users": [
        {
            "id": "string",
            "username": "string",
            "password": "string"
        }
    ]
}

string

Optional

ID of the VASA Provider

string

name

Required

Name of the VASA Provider

string

url

Required

URL of the VASA Provider

array of object

storageContainers

Required

List of storage containers associated with the VASA Provider

array of object

users

Required

List of users associated with the VASA Provider

Responses

201

Created

Returns VasaProvider of type(s) application/json

"VasaProvider Object"

string

Optional

ID of the VASA Provider

string

name

Required

Name of the VASA Provider

string

url

Required

URL of the VASA Provider

array of object

storageContainers

Required

List of storage containers associated with the VASA Provider

array of object

users

Required

List of users associated with the VASA Provider

400

Bad Request

Returns Error of type(s) application/json

"Error Object"

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of object

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

500

InternalServerError

Returns Error of type(s) application/json

"Error Object"

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of object

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","storageContainers":["object"],"url:"string","users":["object"]}' https://{api_host}/v1/vasa-providers

On This Page

Description

Request

Request Body

Response

201 Response Body

Errors

Vasa Providers Operations