Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Return settings used when performing the DNS check.

GET /dns_check/configuration

Returns servers queried to check DNS configuration correctness.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getDnsCheckConfiguration --host https://$HOST:9443

Responses

application/json
200

The DNS check results.

PropertyType & Description
dnsServers
array of strings

A collection of IP addresses for DNS servers used in checking DNS. If empty, local system configuration will be used.

builtInDnsServer
boolean

If true, DNS check will verify that control of DNS zone for Onezone's domain was delegated to the DNS server built into Onezone service. This option is available only in Onezone service.

dnsCheckAcknowledged
boolean

Flag indicating that user completed the DNS check step during interactive deployment.

Example

application/json
{
  "builtInDnsServer": false,
  "dnsServers": [
    "8.8.8.8",
    "8.8.4.4",
    "1.1.1.1"
  ],
  "dnsCheckAcknowledged": true
}
401

Unauthorized request.

403

Forbidden request.

404

Cluster not yet deployed.

500

Internal server error.

PropertyType & Description
error
object

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."
  }
}