GET v1/core/keyservice/{keyNamespace}?alg={alg}&policyName={policyName}&starttime={starttime}&endtime={endtime}

Return an existing key value or creates a new one.

Request Information

Parameters

NameDescriptionAdditional information
keyNamespace

Define this parameter in the request URI.

alg
Algorithm name - must be from list of supported policy names

Define this parameter in the request URI.

policyName
Policy Name - provisioned on DB with an algorithm

Define this parameter in the request URI.

starttime
ISO8601 string

Define this parameter in the request URI.

endtime
ISO8601 string

Define this parameter in the request URI.

Response Information

Key object

Response body formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "Namespace": "sample string 1",
    "Alg": "sample string 2",
    "PolicyName": "sample string 3",
    "StartTime": "2025-05-05T09:53:15.0081355+00:00",
    "Endtime": "2025-05-05T09:53:15.0081355+00:00",
    "Key": "sample string 6"
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:
{"Success":true,"Data":{"Namespace":"sample string 1","Alg":"sample string 2","PolicyName":"sample string 3","StartTime":"2025-05-05T09:53:15.0081355+00:00","Endtime":"2025-05-05T09:53:15.0081355+00:00","Key":"sample string 6"},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:
<PBNBReturnOfPbnbKeyCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <Alg>sample string 2</Alg>
    <Endtime>2025-05-05T09:53:15.0081355+00:00</Endtime>
    <Key>sample string 6</Key>
    <Namespace>sample string 1</Namespace>
    <PolicyName>sample string 3</PolicyName>
    <StartTime>2025-05-05T09:53:15.0081355+00:00</StartTime>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfPbnbKeyCA1DLPoZ>

application/bson

Sample:
�SuccessData�Namespacesample string 1Algsample string 2PolicyNamesample string 3	StartTime/ݟ�	Endtime/ݟ�Keysample string 6ErrorCodeErrorDescriptionsample string 3Metasample string 4