1. Oracle GoldenGate Microservices Architecture REST API
  2. Tasks
  3. Service Manager
  4. Certificates

Replace a Named Certificate

put

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

Replace a named certificate in a deployment. The certificate name must exist in the deployment.

Request

Supported Media Types
Path Parameters
  • Minimum Length: 1
    Maximum Length: 64
    Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

    Deployment certificate name.

  • Minimum Length: 1
    Maximum Length: 32
    Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

    Name for the Oracle GoldenGate deployment.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
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
Nested Schema : User or Trustpoint Certificate Bundle-x-oneOf[0]
Type: object
Show Source
Nested Schema : User or Trustpoint Certificate Bundle-x-oneOf[1]
Type: object
Show Source
Nested Schema : certificateBundle
Type: object
Show Source
Nested Schema : caCertificates
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 128
A collection of PEM encoded ca certificates.
Show Source
Nested Schema : trustpointBundle
Type: object
Show Source
Example Request (application/json)
{
    "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",
        "privateKeyPem":"-----BEGIN PRIVATE KEY-----\nMIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQCk5tyoX/MtwhHk\n3A6pPdimdTPTB1cx8O7oqqDsSjnM6XPm5oVrcJmzDTYB+1FcE5f3ffXavZj46xti\nmu91ELnpIxzNew3fvKQ6JSMtnymfzRPcydkfhXKfPQpVZNAvwYPSSn110sSP8xvQ\nrTVkA3tpoN4OpJPSD+L3Ue+qL6CoWehXnN1zgEK/1HK9PjkEoR5A8vtfTl5F9vEt\nVILUiLXaqzbqA512QVJC7nVvIgUyFqxQd+xRwUVtXvU57qQNWerVtIm3OjtQFyT/\nXzTo2zScoLhQ2fauPlSZd+sLOwtmVICyX/qzcBBVYK5TsEBwoOUdbIk7Ykmodfri\nOroI98qHAgMBAAECggEAESpO8d/7ClpXToFxrUBY2wr8OA1dkD9KP0HzumUHm0L5\n46E/Zi20ciT/6DjnATSw7vxXqUtvLwoaMat7Ha5+C7yx9NnIWe/jEIJpJQiaZp4M\nYUFJrrRPeC/8cWMrIK1+MVe7s5YbC/j8fj5pfl22bQpn0xJiqM0qjSAkWIzYpm16\nr7Aec9TPHu6rGAmJ/Yeg1UvnaYKnE1yyDGwUfxsTnojmA8yih47KR4amC0lt1GhR\nVzaFy5nlWl9gRmYjKn2gmX2Tj4n7tTRPU22jcokO2cqk9cbqKEsPBqKEHV33wr0L\nA6MKTzWOzeYy0FJTbkYEX+Kq9djpi1AdM22kT7yKEQKBgQDRTaqMfbYK4ae/Zl04\nhuSVZXwdq2qiIsfoAW2LiADbfJyDqWpjlTxRLTUPJ0Qls7jPClS2ZWNiI0yXS3vC\n0LzmMWsmquV5AOuU9XloKFROGJC6pBRBtwve2CWOGI4bf5GpejXB/lJ3z055PuW1\nZYmx8CLnyNE5n5gaDEt5zq+RQwKBgQDJsTSoBYDbfUqR6kGEUPH1HyIIDbk738vX\nEgEzEgG1iCRLWurLZW+CFhCM3AmpPNdhwdPEvcV/dgZCZWO8XO5B/eQtpRPeLwwr\n2uEdIB+T7XQUxl6Wv+npMhDj5QNamQ2GqfDPLQ11kfd2Wzi6TZtXR73ad5mQ9t4C\nU2OD30m7bQKBgBCPJXwiAgIQYlYpQhzTx0fulIhAZJpZSBmZ61HLu82hqTxdbfZc\n+z2s5vLA94pIEsoGljcsBFXiVw/tP+hk3V0U8dZIVQliwkCxvx43epwHI4QwsQ2V\n7tF9plL8rFmOmTagXZpwhZPHCf1btY7JbsBuMETIRY1ajA0bhekoKgnDAoGALra/\nVmcn6C5FtjQGhqnk0HwseqcLDwYPhTmjU3vJL41fsqBVH1TYFc4ceTOBfVQdIoQt\nEzVM5++jFX+8MOVpPZmbXsMMLfrBm+qvFvrYtX9a0nD7eXjrqVoyNUZWl4Y5bsYv\ngxyRMHjlUuFf6y6MWxO/sjjfNYcn9mvv8ZwmzKUCgYACbXPUb2Y87rCuTCwymJQz\ndvDjm1Riv2Lb9Cp0+e2GpxmoDBK/gi7mlOJQz+VQuH4GDimp27qb5ud1vATcP3zn\nUVHLI3genpnxW6Z1gCngPKKH44W3hVoobmpfdYXx+VrPUHdQmVubBGRKw3cRN7SG\noLArSkvTKKKG4go72MHwEQ==\n-----END PRIVATE KEY-----\n"
    }
}
Back to Top

Response

Supported Media Types

200 Response

The named certificate was successfully replaced in the deployment.

Body ()
Root Schema : RESTful API Standard Response
Type: object
Title: RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type: object
Oracle GoldenGate document from the request
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • 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])$
    The date and time that the message was issued
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • Minimum Length: 1
    Maximum Length: 4095
    A human-readable description that provides information and detail specific to this occurence of the information, warning or error.
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    An absolute URI [RFC3986] to a page that describes the info, warning or error type.
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"
        }
    ],
    "messages":[
    ]
}
Back to Top