Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Add OneS3 services

POST /provider/ones3

Deploys the OneS3 service on the specified hosts.

NOTE: the OneS3 service requires that the provider is registered in Onezone before it can be started. If it's not the case, the service will be enabled, but its start will be postponed and automatically resumed after the registration.

Request body

application/json

The OneS3 service hosts configuration.

PropertyType & Description
hosts
array of strings

The list of hosts where service should be deployed.

port
integer

The port on which the OneS3 service will be available.

NOTE: This parameter is considered only during the initial cluster deployment or when adding the OneS3 service for the first time. In all other cases, it is ignored, and the port will default to that of the already deployed OneS3 services in the cluster.

Request Examples

application/json
{
  "hosts": [
    "node1.example.com",
    "node2.example.com",
    "node3.example.com"
  ],
  "port": 4443
}

Responses

application/json
202
No description.
400

Invalid request.

PropertyType & Description
error
object (ErrorDetails)

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
401

Unauthorized request.

403

Forbidden request.

500

Internal server error.

PropertyType & Description
error
object (ErrorDetails)

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}