Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Version

get

/services/{version}/masterkey/{keyVersion}

Required Role: User

Retrieve a Master Key by version.

Request

Path Parameters

keyVersion(required): integer

The Master Key version number, 1 to 32767.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Master Key version retrieved.

Root Schema : Oracle GoldenGate Master Key

Type: object

Title: Oracle GoldenGate Master Key

Show Source

$schema:

Allowed Values: [ "ogg:masterkey" ]
created: string

Minimum Length: 20

Maximum Length: 32

Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
status(required):

Allowed Values: [ "current", "available", "unavailable" ]

{
    "title":"Oracle GoldenGate Master Key",
    "required":[
        "status"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:masterkey"
            ]
        },
        "created":{
            "type":"string",
            "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
            "minLength":"20",
            "maxLength":"32"
        },
        "status":{
            "enum":[
                "current",
                "available",
                "unavailable"
            ]
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/masterkey/2",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/masterkey/2",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/keyVersion",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:masterkey",
        "created":"2024-04-03T22:36:23.000+00:00",
        "status":"current"
    }
}