Editing Object Storage by ID

In this article

    This section explains how to edit object storage settings.

    Request

    PUT https://<hostname>:4443/v5/ObjectStorageRepositories/{id}

    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

    id

    string

    An identification number of object storage that you want to edit.

    Request Body

    Property

    Type

    Description

    name

    string

    An object storage name.

    description

    string

    An object storage description.

    sizeLimitEnabled

    boolean

    Specifies if the size limit is set.

    sizeLimitGB

    integer

    Specifies the size limit in GB.

    Request Example

    Request:

    PUT https://<hostname>:4443/v5/ObjectStorageRepositories/5f469f02-0f5b-435e-801d-bd453492451b

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

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

     "description": "New description",

     "sizeLimitEnabled": true,

     "sizeLimitGB": 15

    }

    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.

    I want to report a typo

    There is a misspelling right here:

     

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