Get all keys

GET 
/v2/projects/:projectId/keys

Get all keys

Request

Path Parameters

projectId int64required

Query Parameters

page integer

Default value: 0

Zero-based page index (0..N)

size integer

Possible values: >= 1

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200

OK

application/json

Schema

Schema

_embedded object
keys object[]
Array [
id int64required
Id of key record
name stringrequired
Name of key
namespace string
Namespace of key
description string
Description of key
custom object
Custom values of the key
property name* object
Custom values of the key
]
page object
size int64
totalElements int64
totalPages int64
number int64

Example (from schema)

{
  "_embedded": {
    "keys": [
      {
        "id": 0,
        "name": "this_is_super_key",
        "namespace": "homepage",
        "description": "This key is used on homepage. It's a label of sign up button.",
        "custom": {}
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

400

Bad Request

*/*

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

string

403

Forbidden

*/*

Schema

Schema

string

404

Not Found

*/*

Schema

Schema

string

Loading...