Skip to content

SystemProperties

A SystemProperty defines a key value secure collection dedicated to store system-wide values. There are system-defined ones and user-defined ones, access to all is available by properties API. User defined one could be created and updated by using SetSystemProperty indent.

Operations

List system properties

Request

Security
httpAuth
Query
limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring

Entity id used to the determine beginning of query results.

Enum:"NOTARY_COMMUNICATION_KEY""NOTARY_COLLECTIONS_KEY""NOTARY_API_KEY""STATE_REVIEW_AUTHORITY"
sortBystring

Property name used to sort the query results.

Enum:"id""metadata.createdAt""metadata.lastModifiedAt"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
idArray of strings

Return entities matching given system property id.

Items Enum:"NOTARY_COMMUNICATION_KEY""NOTARY_COLLECTIONS_KEY""NOTARY_API_KEY""STATE_REVIEW_AUTHORITY"
Example:id=NOTARY_API_KEY&id=STATE_REVIEW_AUTHORITY
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/properties?limit=1&startingAfter=NOTARY_COMMUNICATION_KEY&sortBy=id&sortOrder=ASC&id=NOTARY_API_KEY%2CSTATE_REVIEW_AUTHORITY' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
itemsArray of objectsrequired
countinteger, (int32)required
currentStartingAfterstring
nextStartingAfterstring
Response
{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "string",
  "nextStartingAfter": "string"
}