Settings

Returns current settings.

get

Returns current settings. For users with the Standard Registry role only.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

ipfsStorageApiKeystringRequired

operatorIdstringRequired

operatorKeystringRequired

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/settings

HTTPcURLJavaScriptPython

GET /api/v1/settings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "operatorId": "0.0.1858",
  "operatorKey": "",
  "ipfsStorageApiKey": ""
}

Set settings.

post

Set settings. For users with the Standard Registry role only.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ipfsStorageApiKeystringRequired

operatorIdstringRequired

operatorKeystringRequired

Responses

204

Settings updated successfully. No response body.

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/settings

HTTPcURLJavaScriptPython

POST /api/v1/settings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "operatorId": "0.0.1858",
  "operatorKey": "",
  "ipfsStorageApiKey": ""
}

No content

Returns current environment name.

get

Returns current environment name.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

stringOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/settings/environment

HTTPcURLJavaScriptPython

GET /api/v1/settings/environment HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

testnet

Returns package version.

get

Returns package version. For users with the Standard Registry role only.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

versionstringRequired

Application version

Example: 2.8.1

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/settings/about

HTTPcURLJavaScriptPython

GET /api/v1/settings/about HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "version": "2.8.1"
}