Register provider
Registers provider in the zone.
Request body
The new provider details.
The name under which the provider should be registered in a zone.
Indicates how the Oneprovider registration token will be provided:
"inline"- the registration token must be placed in the token field (consult for more information)."fromFile"- the registration token will be read from given file, specified in the tokenFile field (consult for more information).
Registration token obtained from Onezone. This token identifies the Onezone service where the Oneprovider will be registered and authorizes the registration request. Required when the tokenProvisionMethod is set to "inline".
Absolute path to the file containing the Oneprovider registration token. The token (and nothing else) should be placed in the file as plaintext. The file does not have to pre-exist - it may be created after this request is made (Onepanel will wait for the file to appear for some time). Required when the tokenProvisionMethod is set to "fromFile".
If enabled, the storage provider will be assigned a subdomain in onezone's domain and 'subdomain' property must be provided. If disabled, 'domain' property should be provided.
Unique subdomain in onezone's domain for the storage provider. Required if subdomain delegation is enabled.
The fully qualified domain name of the storage provider or its IP address (only for single-node deployments or clusters with a reverse proxy). Required if subdomain delegation is disabled.
The geographical longitude of the storage provider.
The geographical latitude of the storage provider.
Email address of the Oneprovider administrator.
Request Examples
{
"name": "Provider1",
"token": "MDAzM2xvY2F00aW9uIGRldi1vbmV6b25lLmRlZmF1...",
"subdomainDelegation": false,
"domain": "provider.example.com",
"geoLongitude": -24.3776025,
"geoLatitude": -128.3519364
}Responses
Provider has been successfully registered.
Invalid request.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Unauthorized request.
Forbidden request.
Provider already registered.
Internal server error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Services needed to fulfill this request are not running.