List Encryption Keys
get
/services/{version}/enckeys
Retrieve the names of all encryption keys
Request
Path Parameters
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
Collection of Encryption Key names retrieved successfully.
Root Schema : Oracle GoldenGate Collection
Type:
object
Title:
Show Source
Oracle GoldenGate Collection
-
$schema(optional):
Allowed Values:
[ "ogg:collection" ]
-
items:
array items
Minimum Number of Items:
0
Maximum Number of Items:32767
Nested Schema : items
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
32767
-
Array of:
object items
Additional Properties Allowed:
true
Nested Schema : items
Type:
object
Additional Properties Allowed:
Show Source
true
-
$schema(optional):
string
Minimum Length:
1
Maximum Length:255
Default Value:ogg:collectionItem
Name of schema for collection item, defaults to this schema -
links:
array links
Minimum Number of Items:
0
Maximum Number of Items:16
Links for item -
name:
string
Minimum Length:
1
Maximum Length:255
Item name -
status(optional):
status
Item status
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
16
Links for item
Show Source
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:link" ]
-
description(optional):
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6
Maximum Length:255
Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
Relationship of href to the requested link
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/enckeys",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/enckeys",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/enckeys",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:collection",
"items":[
{
"$schema":"ogg:collectionItem",
"links":[
{
"href":"http://localhost:11001/services/v2/enckeys",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:11001/services/v2/enckeys/superkey",
"mediaType":"application/json",
"rel":"canonical"
}
],
"name":"superkey"
}
]
}
}