Configure object storage (v2)
Suggest changes
POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/configure-object-store
Configures object storage. This is V2 version of the object store configure API. It verifies whether a private endpoint is enabled and a certificate is installed. You can verify whether previously created private endpoints are enabled for AWS and Azure. This API endpoint is called if no object stores are found when BlueXP backup and recovery is enabled.
Token usage: BlueXP user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
accountId |
string |
path |
True |
Account id |
workingEnvironmentId |
string |
path |
True |
Working environment ID |
authorization |
string |
header |
True |
User token |
x-agent-id |
string |
header |
True |
Request identifier |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
cloud-provider |
string |
True |
|
object-store-name |
string |
True |
|
ip-space |
string |
False |
|
access-key |
string |
False |
|
secret-password |
string |
False |
|
storage-server |
string |
False |
|
region |
string |
False |
|
aws |
False |
||
azure |
False |
Example request
{
"cloud-provider": "string",
"object-store-name": "string",
"ip-space": "string",
"access-key": "string",
"secret-password": "string",
"storage-server": "string",
"region": "string",
"aws": {
"account-id": "string",
"private-endpoint": {
"id": "string"
}
},
"azure": {
"subscription": "string",
"private-endpoint": {
"subnet": "string"
}
}
}Response
Status: 202, Default response| Name | Type | Required | Description |
|---|---|---|---|
job-id |
string |
False |
Example response
{
"job-id": "string"
}Definitions
See Definitions
private-endpoint
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
False |
Optional input field for private endpoint |
aws
| Name | Type | Required | Description |
|---|---|---|---|
account-id |
string |
False |
Required when the provider is AWS |
private-endpoint |
False |
private-endpoint
Required input field for an on-premises use case for private link configuration
| Name | Type | Required | Description |
|---|---|---|---|
subnet |
string |
False |
Required input field for an on-premises private link configuration |
azure
| Name | Type | Required | Description |
|---|---|---|---|
subscription |
string |
False |
Required when the provider is Azure |
private-endpoint |
False |
Required input field for an on-premises use case for private link configuration |
body
| Name | Type | Required | Description |
|---|---|---|---|
cloud-provider |
string |
True |
|
object-store-name |
string |
True |
|
ip-space |
string |
False |
|
access-key |
string |
False |
|
secret-password |
string |
False |
|
storage-server |
string |
False |
|
region |
string |
False |
|
aws |
False |
||
azure |
False |