Get current provider details
Returns information about the Oneprovider that performed the request.
This operation requires provider authentication - see provider auth token.
Example cURL requests
Get information about provider
curl -H "x-auth-token: $TOKEN" https://$ZONE_HOST/api/v3/onezone/provider
{
"providerId": "6b9bc70630547d925861a27e1f050dfe",
"name": "Example provider",
"domain": "provider1.example.com",
"latitude": 50.0647,
"longitude": 19.945,
"clusterId": "6b9bc70630547d925861a27e1f050dfe",
"online": true,
"creationTime": 1576152793
}
Request Examples
onezone-rest-cli getCurrentProviderDetailsResponses
Returns the information about Oneprovider.
The Oneprovider Id.
Oneprovider name.
The fully qualified domain name of the Oneprovider. In rare cases, the domain may have the form of an IP address instead of an FQDN.
The geographical latitude of the Oneprovider's data center location.
The geographical longitude of the Oneprovider's data center location.
The Id of the corresponding Oneprovider cluster.
True if this Oneprovider is online - connected to Onezone.
Timestamp in seconds (UNIX epoch), e.g. 1563819329.
Example
{
"providerId": "6b9bc70630547d925861a27e1f050dfe",
"name": "Example provider",
"domain": "provider1.example.com",
"latitude": 50.0647,
"longitude": 19.945,
"clusterId": "6b9bc70630547d925861a27e1f050dfe",
"online": true,
"creationTime": 1576152793
}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."
}
}Authentication 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."
}
}Authorization 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."
}
}Resource not found.
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."
}
}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."
}
}