DDBoost Directory Controller Resource

GET /ddboost-configuration/check-storage-exists

Request Parameters
name type description
address query
adminAccount query
adminPassword query
storageToCheck query
Response Body
media type data type description
application/json DDBoostConfigResult (JSON)

Example

Request
GET /ddboost-configuration/check-storage-exists
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /ddboost-configuration/check-user-exists

Request Parameters
name type description
address query
adminAccount query
adminPassword query
userToCheck query
Response Body
media type data type description
application/json DDBoostConfigResult (JSON)

Example

Request
GET /ddboost-configuration/check-user-exists
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

POST /ddboost-configuration/storage

Request Body
media type data type
application/json DdBoostStorageCreateRequest (JSON)
Response Body
media type data type description
application/json DDBoostConfigResult (JSON)

Example

Request
POST /ddboost-configuration/storage
Content-Type: application/json
Accept: application/json

                
{
  "address" : "...",
  "storageUnit" : "...",
  "softLimitSize" : 12345,
  "softLimitUnit" : "...",
  "hardLimitSize" : 12345,
  "hardLimitUnit" : "...",
  "user" : "...",
  "adminAccount" : "...",
  "adminPassword" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

PUT /ddboost-configuration/storage

Request Body
media type data type
application/json DdBoostStorageUpdateRequest (JSON)
Response Body
media type data type description
application/json DDBoostConfigResult (JSON)

Example

Request
PUT /ddboost-configuration/storage
Content-Type: application/json
Accept: application/json

                
{
  "address" : "...",
  "storageUnit" : "...",
  "user" : "...",
  "adminAccount" : "...",
  "adminPassword" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /ddboost-configuration/storage-owner

Request Parameters
name type description
address query
adminAccount query
adminPassword query
storageToCheck query
Response Body
media type data type description
application/json DDBoostConfigResult (JSON)

Example

Request
GET /ddboost-configuration/storage-owner
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /ddboost-configuration/storage-units

Request Parameters
name type description constraints
address query  
adminAccount query  
adminPassword query  
page query required int
size query required int
Response Body
media type data type description
application/json DDBoostGetStoragesResult (JSON)

Example

Request
GET /ddboost-configuration/storage-units
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /ddboost-configuration/test-admin-connection

Request Parameters
name type description
address query
password query
user query
Response Body
media type data type description
application/json DDBoostConfigResult (JSON)

Example

Request
GET /ddboost-configuration/test-admin-connection
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /ddboost-configuration/test-user-connection

Request Parameters
name type description
address query
password query
user query
Response Body
media type data type description
application/json DDBoostConfigResult (JSON)

Example

Request
GET /ddboost-configuration/test-user-connection
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

POST /ddboost-configuration/user

Request Body
media type data type
application/json DdBoostCreateUserParameters (JSON)
Response Body
media type data type description
application/json DDBoostConfigResult (JSON)

Example

Request
POST /ddboost-configuration/user
Content-Type: application/json
Accept: application/json

                
{
  "address" : "...",
  "user" : "...",
  "password" : "...",
  "adminAccount" : "...",
  "adminPassword" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

GET /ddboost-configuration/users

Request Parameters
name type description constraints
address query  
adminAccount query  
adminPassword query  
page query required int
size query required int
Response Body
media type data type description
application/json DDBoostGetUsersResult (JSON)

Example

Request
GET /ddboost-configuration/users
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }