Getting Bucket by Name

In this article

    You can get information about S3 Compatible or IBM object storage bucket with the specified name.

    Getting Bucket by Name Note

    If an object storage uses a self-signed SSL certificate, you must add this certificate to the trusted root of the server that runs Veeam Backup for Microsoft 365 REST API service. Otherwise, this method will not work.

    Request

    GET https://<hostname>:4443/v6/S3CompatibleResources/buckets/{Name}

    Request Headers

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

    Request Parameters

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

    Parameter

    Type

    Description

    Name

    string

    Specifies the bucket name. For more information on how to get this parameter, see Getting Buckets.

    accountId

    string

    Specifies the identification number of a cloud account. For more information on how to get this parameter, see Getting Accounts.

    ServicePoint

    string

    Specifies an endpoint address.

    CustomRegionId

    string

    Specifies a region ID.

    Request Body

    None.

    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

    The response body contains the following properties:

    Property

    Type

    Description

    servicePoint

    string

    Specifies the endpoint address.

    customRegionId

    string

    Specifies the region ID.

    name

    string

    Specifies the bucket name.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    The example shows how to get information about the S3 Compatible object storage bucket with the specified name that was created by the specified cloud account.

    Request:

    GET https://abc.tech.local:4443/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "servicePoint": "https://my.servicepoint.com:443",

     "customRegionId": "us-east-1",

     "name": "d3e020df-9144-4fa3-a2ff-a83abb3f7cfa",

     "links": {

       "self": {

         "href": "v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1"

       },

       "account": {

         "href": "v6/accounts/ed531412-7646-4fa1-bea5-986c04bcb89c"

       }

     }

    }