s3 post create

POST /api/v1.0/s3/create

Creates a new bucket via s3 on the cloud provider.

Request

Headers

Header	Value
content-type	application/json
Async	boolean

NOTE: The async header is optional. If set to true, the request will be processed asynchronously and the response will contain a poolingURL with the URL to check the status of the request. If set to false, the request will be processed synchronously and the response will contain the result of the request.

Body

{
  "client_uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "req": {
    "name": "s3test",
    "region": "eu-central-2"
  }
}

Body Attributes

client_uid

Type: string
Description:
The unique identifier of the client.

req

Type: object
Description:
The request object.
Attributes:

• name:
  • Type: string
  • Description: The name of the bucket.
• region:
  • Type: string
  • Description: The region of the bucket.

Response

Headers

Header	Value
content-type	application/json

Body

Synchronous Response

{
  "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "name": "s3test",
  "region": "eu-central-2",
  "size": 1,
  "client_uid": "ffffffff-ffff-ffff-ffff-ffffffffffff"
}

Body Attributes

id

Type: string
Description:
An uuid4 that identifies the bucket.

name

Type: string
Description:
The name of the bucket.

region

Type: string
Description:
The region of the bucket.

size

Type: integer
Description:
The size of the bucket in GB.

client_uid

Type: string
Description:
The unique identifier of the client.

Async Response

{
  "service_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "poolingURL": "https://<meson_ip>:7770/api/v1.0/running/<bucket_id>"
}

Body Attributes

service_id

Type: string
Description:
The unique identifier of the bucket on the cloud provider.

poolingURL

Type: string
Description:
The URL to check the status of the request.