Jump to

• Request
• Response

Setup replication agreement between DCs

post

/oam/services/rest/_replication/setup

To be executed only on the Master Data Center / Master Policy Manager (for OAuth Consent Management only). It validates the MDC Partners based on the input and creates the replication agreement in Master and Clone Data Center.

Request

Supported Media Types

• application/json

Body ()

Root Schema : replAgreementParameters

Type: object

Show Source

• config(optional): object config
• documentType: string
  Document type should be
  * "ENTITY" - On OAM Admin REST Endpoint
  * "RUNTIME_ENTITY" - On OAM PolicyManager REST Endpoint
• name: string
  Name for the replication agreement
• source: string
  Cluster Name of the Master Data Center. This can be obtained using MDC diagnostic API (Get DC specific details)
• target: string
  Cluster Name of the Clone Data Center. This can be obtained using MDC diagnostic API (Get DC specific details)

{
    "type":"object",
    "required":[
        "name",
        "source",
        "target",
        "documentType"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name for the replication agreement"
        },
        "source":{
            "type":"string",
            "description":"Cluster Name of the Master Data Center. This can be obtained using MDC diagnostic API (Get DC specific details)"
        },
        "target":{
            "type":"string",
            "description":"Cluster Name of  the Clone Data Center. This can be obtained using MDC diagnostic API (Get DC specific details)"
        },
        "documentType":{
            "type":"string",
            "description":"Document type should be <br/> * \"ENTITY\" - On OAM Admin REST Endpoint <br/> * \"RUNTIME_ENTITY\" - On OAM PolicyManager REST Endpoint"
        },
        "config":{
            "type":"object",
            "properties":{
                "entry":{
                    "type":"object",
                    "properties":{
                        "key":{
                            "type":"string",
                            "description":"authorization"
                        },
                        "value":{
                            "type":"string",
                            "description":"Authorization Header to be used for contacting clone Data Center"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : config

Type: object

Show Source

• entry(optional): object entry

{
    "type":"object",
    "properties":{
        "entry":{
            "type":"object",
            "properties":{
                "key":{
                    "type":"string",
                    "description":"authorization"
                },
                "value":{
                    "type":"string",
                    "description":"Authorization Header to be used for contacting clone Data Center"
                }
            }
        }
    }
}

Nested Schema : entry

Type: object

Show Source

• key(optional): string
  authorization
• value(optional): string
  Authorization Header to be used for contacting clone Data Center

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"authorization"
        },
        "value":{
            "type":"string",
            "description":"Authorization Header to be used for contacting clone Data Center"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response body shall indicate the status

Body ()

Root Schema : replAgreementResponse

Type: object

Show Source

• enabled(optional): string
  true|false
• identifier(optional): string
  Replication Agreement Identifier
• lastSequenceNumber(optional): string
  Sequence Number last applied in the DC
• ok(optional): string
  true|false
• pollInterval(optional): string
  Duration after which the Clone DC should poll and apply the changes from Master DC
• startingSequenceNumber(optional): string
  Sequence Number after which Replication will occur
• state(optional): string
  Current State of the Replication Agreement (ACTIVE|BOOTSTRAPPING|READY)

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"string",
            "description":"true|false"
        },
        "identifier":{
            "type":"string",
            "description":"Replication Agreement Identifier"
        },
        "lastSequenceNumber":{
            "type":"string",
            "description":"Sequence Number last applied in the DC"
        },
        "ok":{
            "type":"string",
            "description":"true|false"
        },
        "pollInterval":{
            "type":"string",
            "description":"Duration after which the Clone DC should poll and apply the changes from Master DC"
        },
        "startingSequenceNumber":{
            "type":"string",
            "description":"Sequence Number after which Replication will occur"
        },
        "state":{
            "type":"string",
            "description":"Current State of the Replication Agreement (ACTIVE|BOOTSTRAPPING|READY)"
        }
    }
}

500 Response

Error

Back to Top