Hub 2.0 Help

Get All Key Stores

Request

GET /keystores?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define the subset.
$skip Optional query parameter. Number of key stores to skip before returning the first entry in the page.
$top Optional query parameter. Maximum number of key stores to return in the page.
query

Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for key stores:

id: value — Settings by given id

name: keyStoreName — Settings by provided name

orderBy Order results. See Sorting Syntax for details. Key stores can be ordered by the following fields: name

Response

Response Code Meaning
200 OK Successful request.
400 Bad Request Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource wasn't found.
500 Internal Server Error Failed to process request because of the server error. The response contains message describing the error.

Response body

page

{ "skip": int, /* Requested number of key stores to skip before returning the first entry in the page */ "top": int, /* Requested maximum number of key stores to return in the page */ "total": int, /* Total number of key stores. Returned only if the total field is included as a value of the fields parameter in the query */ "keystores": [keyStore, ...] }
Last modified: 19 September 2016