Settings

Global application configuration and environment settings.

Returns current settings.

get

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

Authorizations

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ipfsStorageApiKeystringRequired

operatorIdstringRequired

operatorKeystringRequired

Responses

204

Settings updated successfully. No response body.

No content

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post/settings

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

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

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

testnet

Returns geospatial file limits.

get

Returns geospatial preview and upload limits in megabytes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

objectOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get/settings/geospatial-limits

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

{}

Returns package version.

get

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

Authorizations

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

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

{
  "version": "2.8.1"
}