Skip to main content

Configure object storage

Contributors

POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/configure-object-store

Configures object storage. Verifies whether a private endpoint is enabled and a certificate is installed. 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

account-id

string

False

subscription

string

False
Example request 
{
  "cloud-provider": "string",
  "object-store-name": "string",
  "ip-space": "string",
  "access-key": "string",
  "secret-password": "string",
  "storage-server": "string",
  "region": "string",
  "account-id": "string",
  "subscription": "string"
}
JSON
Copy

Response

Status: 201, Default response

Definitions

See Definitions

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

account-id

string

False

subscription

string

False