Sign in

v1

latestSwagger 2.02026-07-17332466.5 KB
lists

Clone list

Creates a clone of the list to a new list with the supplied metadata. The URL list is the source and the payload must contain the new list ID.

Required security scopes:

  • api:manage
put/lists/{list_id}/clone

Path parameters

list_idstring required

The ID of the list to apply the operation on. Can be a to z (both upper/lower case), 0 to 9 or one of these characters _-.

Request body

idstring required

The ID of the list to apply the operation on. Can be a to z (both upper/lower case), 0 to 9 or one of these characters _-.

load_indexboolean

Load Index on server startup

merge_sizeinteger

Merge adjacent Segments with less than this number of entries

metadataobject

Custom metadata. String to String hash.

setstring required

Set used for storage

split_sizeinteger

Split Segments larger than this number of entries

Example request

{
  "id": "highscore-list",
  "load_index": false,
  "merge_size": 500,
  "metadata": {
    "country": "dk",
    "game": "2"
  },
  "populate": [
    {
      "id": 100,
      "payload": {
        "country": "dk",
        "name": "Mark Anthony"
      },
      "score": 100,
      "tie_breaker": 2000
    },
    {
      "id": 100,
      "payload": {
        "country": "dk",
        "name": "Mark Anthony"
      },
      "score": 100,
      "tie_breaker": 2000
    }
  ],
  "set": "storage-set",
  "split_size": 2000
}

Response

OK