Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Modify progress markers

PATCH /progress

Sets or unsets markers for completed deployment stages.

Request body

application/json

Property	Type & Description
clusterIps boolean True after user confirmed detected external IPs or if interactiveDeployment was disabled.
webCertificate boolean True after user decided whether to use Let's Encrypt certificates or if interactiveDeployment was disabled.
dnsCheck boolean True after user reviewed results of DNS check or if interactiveDeployment was disabled.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE modifyProgress dnsCheck==true --host https://$HOST:9443

Responses

application/json

204

Changes successfully saved.

400

Invalid request.

Property

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

401

Unauthorized request.

403

Forbidden request.

500

Internal server error.

Property

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