Editing Object Storage by ID

In this article

    You can edit the object storage settings.

    Request

    PUT https://<hostname>:4443/v6/objectstoragerepositories/{repositoryId}

    Request Headers

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

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    repositoryId

    string

    Specifies the identification number of the object storage. For more information on how to get this parameter, see Getting Object Storage Repositories.

    Request Body

    The request body must contain the following properties:

    Property

    Type

    Description

    name

    string

    Specifies the object storage name.

    description

    string

    Specifies the object storage description.

    sizeLimitEnabled

    boolean

    Defines whether the size limit is set.

    sizeLimitGB

    integer

    Specifies size limit in GB.

    useArchiverAppliance

    boolean

    Defines that Veeam Backup for Microsoft 365 will use the Amazon archiver appliance when transferring backed-up data to the archive object storage.

    amazonArchiverAppliance

    amazonArchiverAppliance

    Contains a definition of the Amazon archiver appliance that Veeam Backup for Microsoft 365 will use when transferring backed-up data to the archive object storage.

    amazonArchiverAppliance

    Property

    Type

    Description

    instanceType

    Instance Type

    Specifies an instance type that the Amazon archiver appliance will use.

    virtualPrivateCloud

    Virtual Private Cloud

    Specifies Amazon Virtual Private Cloud (Amazon VPC).

    subnet

    Subnet

    Specifies the Amazon archiver appliance subnet.

    securityGroup

    Security Group

    Specifies a security group that will be associated with the Amazon archiver appliance.

    appliancePort

    integer

    Specifies a port number that will be used to route requests between the Amazon archiver appliance and Veeam Backup for Microsoft 365 backup infrastructure components.

    Request Example

    Request:

    PUT https://abc.tech.local:4443/v6/objectstoragerepositories/af15334e-824b-490f-90c9-a121efe51d67

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "name": "Amazon Object Storage (Edited through REST)",

     "description": "New description",

     "sizeLimitEnabled": true,

     "sizeLimitGB": "2048"

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    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

    None.