Adding Accounts

In this article

    This section explains how to add a new cloud credentials record.

    Request

    POST https://<hostname>:4443/v5/Accounts

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Body

    The following table lists available request properties.

    Property

    Type

    Description

    accountType

    string

    An account type:

    • azureBlobAccount
    • amazonS3Account
    • amazonS3CompatibleAccount

    userName

    string

    An account user name.

    Must contain only lowercase characters.

    password

    string

    A password for the account you want to add.

    description

    string

    An account description.

    Request Example

    Request:

    POST https://abc.tech.local:4443/v5/Accounts/

     

    Request Header:

    Authorization: Bearer <Access-Token>


    Request Body:

    {

      "accountType": "azureBlobAccount",

      "userName": "azureuser",

      "password": "XXXXXXXXXXXXXXXXXX",

      "description": "An new Azure account"

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 201 Created.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    Property

    Type

    Description

    id

    string

    An account identification number.

    accountType

    string

    An account type:

    • azureBlobAccount
    • amazonS3Account
    • amazonS3CompatibleAccount

    userName

    string

    An account user name.

    description

    string

    An account description.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Response Example

    Response:

    201 Created

     

    Response Body:

    {

      "accountType": "azureBlobAccount",

      "userName": "azureuser",

      "_links": {"self": {"href": "https://abc.tech.local:4443/v5/accounts/8714ce3f-8b3f-44a9-acaa-fec59ae2f9eb"}},

      "id": "8714ce3f-8b3f-44a9-acaa-fec59ae2f9eb",

      "description": "An Azure Account"

    }

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.