Hub 2018.1 Help

Get All Key Stores


GET <REST API URL>/keystores?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional Lets you specify a subset of the fields to be returned. Use Fields Syntax to define the subset.
$skip Optional Lets you set a number of entries to skip before returning the first entry of the page.
$top Optional Lets you set the maximum number of entries to return in the page.

Optional Lets you filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the KeyStores, the following fields and tuples are supported:

id: value — SSL key store with the given ID

name: keyStoreName — SSL key store with the given name

orderBy Optional Lets you order the returned results. See Sorting Syntax for details. KeyStores support ordering by the following fields: name


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 a message that describes the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource was not found.
500 Internal Server Error Failed to process request because of the server error. The response contains a message that describes the error.

Response body


{ "skip": int, "top": int, "total": int, "keystores": [keyStore, ...] }
Last modified: 5 April 2018