Jump to

• Request
• Response

Retrieve Certificate

get

/services/{version}/deployments/{deployment}/certificates/{type}/{certificate}

Retrieve the certificate PEM data for the named certificate in the deployment.

Request

Path Parameters

• certificate: string
  Minimum Length: 1

  Maximum Length: 64

  Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

  Deployment certificate name.

• deployment: string
  Minimum Length: 1

  Maximum Length: 32

  Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

  Name for the Oracle GoldenGate deployment.

• version: string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

The certificate PEM data was retrieved successfully.

Body ()

Root Schema : User or Trustpoint Certificate Bundle

Title: User or Trustpoint Certificate Bundle

A bundle containing either a user certificate or a trustpoint certificate.

Match One

Show Source

• object User or Trustpoint Certificate Bundle-x-oneOf[0]
• object User or Trustpoint Certificate Bundle-x-oneOf[1]

{
    "x-oneOf":[
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:userCertificateBundle"
                    ]
                },
                "certificateBundle":{
                    "type":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "ogg:certificateWithPvtKeyPem"
                            ]
                        },
                        "certificatePem":{
                            "description":"Certificate PEM data.",
                            "type":"string",
                            "minLength":1,
                            "maxLength":523288
                        },
                        "privateKeyPem":{
                            "description":"Certificate PEM data.",
                            "type":"string",
                            "minLength":1,
                            "maxLength":523288
                        },
                        "caCertificates":{
                            "description":"A collection of PEM encoded ca certificates.",
                            "type":"array",
                            "minItems":1,
                            "maxItems":128,
                            "items":{
                                "description":"Certificate PEM data.",
                                "type":"string",
                                "minLength":1,
                                "maxLength":523288
                            }
                        }
                    },
                    "required":[
                        "certificatePem"
                    ],
                    "additionalProperties":false
                }
            },
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:trustpointBundle"
                    ]
                },
                "trustpointBundle":{
                    "type":"object",
                    "properties":{
                        "trustpointPem":{
                            "description":"Certificate PEM data.",
                            "type":"string",
                            "minLength":1,
                            "maxLength":523288
                        }
                    },
                    "required":[
                        "trustpointPem"
                    ],
                    "additionalProperties":false
                }
            },
            "additionalProperties":false
        }
    ],
    "title":"User or Trustpoint Certificate Bundle",
    "description":"A bundle containing either a user certificate or a trustpoint certificate."
}

Nested Schema : User or Trustpoint Certificate Bundle-x-oneOf[0]

Type: object

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:userCertificateBundle" ]
• certificateBundle(optional): object certificateBundle

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:userCertificateBundle"
            ]
        },
        "certificateBundle":{
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:certificateWithPvtKeyPem"
                    ]
                },
                "certificatePem":{
                    "description":"Certificate PEM data.",
                    "type":"string",
                    "minLength":1,
                    "maxLength":523288
                },
                "privateKeyPem":{
                    "description":"Certificate PEM data.",
                    "type":"string",
                    "minLength":1,
                    "maxLength":523288
                },
                "caCertificates":{
                    "description":"A collection of PEM encoded ca certificates.",
                    "type":"array",
                    "minItems":1,
                    "maxItems":128,
                    "items":{
                        "description":"Certificate PEM data.",
                        "type":"string",
                        "minLength":1,
                        "maxLength":523288
                    }
                }
            },
            "required":[
                "certificatePem"
            ],
            "additionalProperties":false
        }
    },
    "additionalProperties":false
}

Nested Schema : User or Trustpoint Certificate Bundle-x-oneOf[1]

Type: object

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:trustpointBundle" ]
• trustpointBundle(optional): object trustpointBundle

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:trustpointBundle"
            ]
        },
        "trustpointBundle":{
            "type":"object",
            "properties":{
                "trustpointPem":{
                    "description":"Certificate PEM data.",
                    "type":"string",
                    "minLength":1,
                    "maxLength":523288
                }
            },
            "required":[
                "trustpointPem"
            ],
            "additionalProperties":false
        }
    },
    "additionalProperties":false
}

Nested Schema : certificateBundle

Type: object

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:certificateWithPvtKeyPem" ]
• caCertificates(optional): array caCertificates
  Minimum Number of Items: 1

  Maximum Number of Items: 128

  A collection of PEM encoded ca certificates.
• certificatePem: string
  Minimum Length: 1

  Maximum Length: 523288

  Certificate PEM data.
• privateKeyPem(optional): string
  Minimum Length: 1

  Maximum Length: 523288

  Certificate PEM data.

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:certificateWithPvtKeyPem"
            ]
        },
        "certificatePem":{
            "description":"Certificate PEM data.",
            "type":"string",
            "minLength":1,
            "maxLength":523288
        },
        "privateKeyPem":{
            "description":"Certificate PEM data.",
            "type":"string",
            "minLength":1,
            "maxLength":523288
        },
        "caCertificates":{
            "description":"A collection of PEM encoded ca certificates.",
            "type":"array",
            "minItems":1,
            "maxItems":128,
            "items":{
                "description":"Certificate PEM data.",
                "type":"string",
                "minLength":1,
                "maxLength":523288
            }
        }
    },
    "required":[
        "certificatePem"
    ],
    "additionalProperties":false
}

Nested Schema : caCertificates

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 128

A collection of PEM encoded ca certificates.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 523288

  Certificate PEM data.

{
    "description":"A collection of PEM encoded ca certificates.",
    "type":"array",
    "minItems":1,
    "maxItems":128,
    "items":{
        "description":"Certificate PEM data.",
        "type":"string",
        "minLength":1,
        "maxLength":523288
    }
}

Nested Schema : trustpointBundle

Type: object

Show Source

• trustpointPem: string
  Minimum Length: 1

  Maximum Length: 523288

  Certificate PEM data.

{
    "type":"object",
    "properties":{
        "trustpointPem":{
            "description":"Certificate PEM data.",
            "type":"string",
            "minLength":1,
            "maxLength":523288
        }
    },
    "required":[
        "trustpointPem"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11000/services/v2/deployments/Certificates/certificates/server/ServiceDefault",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11000/services/v2/deployments/Certificates/certificates/server/ServiceDefault",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11000/services/v2/metadata-catalog/certificate",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "certificateBundle":{
            "caCertificates":[
                "-----BEGIN CERTIFICATE-----\nMIIELTCCAxWgAwIBAgIJANQK5XCo/wLgMA0GCSqGSIb3DQEBCwUAMIGsMQswCQYD\nVQQGEwJVUzELMAkGA1UECAwCQ0ExFzAVBgNVBAcMDlJlZHdvb2QgU2hvcmVzMRQw\nEgYDVQQKDAtPcmFjbGUgQ29ycDEaMBgGA1UECwwRU2VydmVyIFRlY2hub2xvZ3kx\nHzAdBgNVBAsMFkVudGVycHJpc2UgUmVwbGljYXRpb24xEzARBgNVBAsMCkdvbGRl\nbkdhdGUxDzANBgNVBAMMBlJvb3RDQTAeFw0yMDA5MTYxOTU3MjFaFw0yMDExMTUx\nOTU3MjFaMIGsMQswCQYDVQQGEwJVUzELMAkGA1UECAwCQ0ExFzAVBgNVBAcMDlJl\nZHdvb2QgU2hvcmVzMRQwEgYDVQQKDAtPcmFjbGUgQ29ycDEaMBgGA1UECwwRU2Vy\ndmVyIFRlY2hub2xvZ3kxHzAdBgNVBAsMFkVudGVycHJpc2UgUmVwbGljYXRpb24x\nEzARBgNVBAsMCkdvbGRlbkdhdGUxDzANBgNVBAMMBlJvb3RDQTCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALpmdJmXL2+P6x1y0iYZj156a3Sfu6wS4io1\naaoBgMwlMv19qoI0kRaX4lGyKWaKHZ/crwgS4/7/15InS/xhkpX51mQcG4QAEBqQ\nOih4bVfVoXGqhCwTkcxr6rjiB70RfyRL3mR5TbxqUGRyM8rxjuIC/LJIN5Qf6UYB\nYeF5YuLtg3HoduJWLGqbZb7v4/FmNJ5hz1kIs1R+0o0IUB6yYEAxcAa1y/NvebJ7\nXVFH+ndjTGc699P3GTV4FhPC0r4QNWWkOqY2GhNyX92wcVECbcyeHJIknbSUMXJQ\n1WVvOPiLWHrInZyI2F8wkjRM7S5DpfAWjmJKd+0dL/Wxwy5+3IcCAwEAAaNQME4w\nHQYDVR0OBBYEFMWMLvqdvGCO0x1vlCJklWP6A5yZMB8GA1UdIwQYMBaAFMWMLvqd\nvGCO0x1vlCJklWP6A5yZMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEB\nAIeGtrWXd+WXBFg5ummzhniW1xHZuoNGSdJfayC1AuOIIUc9N15WCJRWoFE/T+mm\nqPmCzkTSiBSdTQ+polc1e56LFjtxue+k6ZM1FbMs9Z3cMmMRtE5sx80VXeezsWPR\nR56H9WdY9PhxALPv1hHLO1NR2eqBMhO0JUgISqLEM9pjgqO7CRAeLeooi6Gb0P7L\n48eHl31szJcbPk/NocX767kK6OfUwHZ/aAcnOoWmrFoU0nUgxbVFCJYi8+QWpEjw\nBbsQkybE8rAPTOJfMHDXdiIQu6EiYTii1Z5XqZj1c+HL3k04gG9cec0oTx9I+7MR\njRUKA8gbTip9o18gLhopz9U=\n-----END CERTIFICATE-----\n"
            ],
            "certificatePem":"-----BEGIN CERTIFICATE-----\nMIID+DCCAuCgAwIBAgIJAI+GagM807LjMA0GCSqGSIb3DQEBCwUAMIGsMQswCQYD\nVQQGEwJVUzELMAkGA1UECAwCQ0ExFzAVBgNVBAcMDlJlZHdvb2QgU2hvcmVzMRQw\nEgYDVQQKDAtPcmFjbGUgQ29ycDEaMBgGA1UECwwRU2VydmVyIFRlY2hub2xvZ3kx\nHzAdBgNVBAsMFkVudGVycHJpc2UgUmVwbGljYXRpb24xEzARBgNVBAsMCkdvbGRl\nbkdhdGUxDzANBgNVBAMMBlJvb3RDQTAeFw0yMDA5MTYxOTU3MjFaFw0yMDExMTUx\nOTU3MjFaMIGwMQswCQYDVQQGEwJVUzELMAkGA1UECAwCQ0ExFzAVBgNVBAcMDlJl\nZHdvb2QgU2hvcmVzMRQwEgYDVQQKDAtPcmFjbGUgQ29ycDEaMBgGA1UECwwRU2Vy\ndmVyIFRlY2hub2xvZ3kxHzAdBgNVBAsMFkVudGVycHJpc2UgUmVwbGljYXRpb24x\nEzARBgNVBAsMCkdvbGRlbkdhdGUxEzARBgNVBAMMCkRpc3RTcnZyXzEwggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCk5tyoX/MtwhHk3A6pPdimdTPTB1cx\n8O7oqqDsSjnM6XPm5oVrcJmzDTYB+1FcE5f3ffXavZj46xtimu91ELnpIxzNew3f\nvKQ6JSMtnymfzRPcydkfhXKfPQpVZNAvwYPSSn110sSP8xvQrTVkA3tpoN4OpJPS\nD+L3Ue+qL6CoWehXnN1zgEK/1HK9PjkEoR5A8vtfTl5F9vEtVILUiLXaqzbqA512\nQVJC7nVvIgUyFqxQd+xRwUVtXvU57qQNWerVtIm3OjtQFyT/XzTo2zScoLhQ2fau\nPlSZd+sLOwtmVICyX/qzcBBVYK5TsEBwoOUdbIk7YkmodfriOroI98qHAgMBAAGj\nFzAVMBMGA1UdJQQMMAoGCCsGAQUFBwMCMA0GCSqGSIb3DQEBCwUAA4IBAQCIWK+F\n6uERGIuOYyXVmm2GN1yK3EYzbS6W5vmID/EFE/FfnoFswIHMgWBmHkmuMwnt5gXW\nG/SR9QH1astAK0vW6mYjWqkb4pAAFoKEK07cE+Jlw7wg+md3X3zSRejkOUaLiw73\n6PVUN+Y6v0jvqk0XoQP752gREC5Td/uXNmyArxzG/IGWhNyILltu17kPMfAQ5MgE\nOvbddUtkS6knTeLjuo4no21vJrRAajFUzdS04JjV/dL6+2nUCM5HWFhP7gE8UErp\nFWvcG2rYE5pdalfWGgB3eKl9AhjYxYEV1kdjPl4wa4r4jU6dC4BVkkN5IqYncMCU\nsb8xjAhnxVZYbjVN\n-----END CERTIFICATE-----\n"
        }
    }
}

Back to Top