REST API for Oracle Unified Directory Administration

Add, Search, Compare or Delete Replication Server

post

/rest/v1/admin

Add, Search, Compare or Delete Replication Server

Request

Supported Media Types

application/json

Replication Server that needs to be created

Root Schema : Replication Server POSTRequest

Type: object

Show Source

assertion: string

Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.
attributes: object Replication Server Properties
base: string

Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation
controls: array controls

LDAP controls to be sent to server for the LDAP operation.
dn: string

LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.
filter: string

Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
msgType(required): string

Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]

The REST message type
requiredAttributes: array requiredAttributes

List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
scope: string

Allowed Values: [ "base", "sub", "one" ]

Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Replication Server Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

Nested Schema : Replication Server Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-assured-timeout: string

Default Value: 1000ms

The timeout value when waiting for assured mode acknowledgments.
ds-cfg-degraded-status-threshold: integer(int32)

Default Value: 5000

The number of pending changes as threshold value for putting a directory server in degraded status.
ds-cfg-disk-full-replication-purge-delay: string

Default Value: 18000s

The time (in seconds) after which the Replication Server erases all persistent information when the disk space falls below the value specified disk-low-threshold.
ds-cfg-disk-full-threshold: string

Default Value: 20 megabytes

Full disk threshold to stop the replication server
ds-cfg-disk-low-threshold: string

Default Value: 100 megabytes

Low disk threshold to start purging all persistent information
ds-cfg-group-id: integer(int32)

Default Value: 1

The group id for the replication server.
ds-cfg-handshake-timeout: string

Default Value: 4000ms

Specifies the handshake-timeout interval for the handshake between the replication servers.
ds-cfg-heartbeat-interval: string

Default Value: 10000ms

The maximum period of time that the connection to a peer RS will be considered active.
ds-cfg-monitoring-period: string

Default Value: 3000ms

The period between sending of monitoring messages.
ds-cfg-queue-size: integer(int32)

Default Value: 10000

Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain.
ds-cfg-replication-db-directory: string

Read Only: true

Default Value: changelogDb

The path where the Replication Server stores all persistent information.
ds-cfg-replication-port(required): integer(int32)

The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.
ds-cfg-replication-purge-delay: string

Default Value: 360000s

The time (in seconds) after which the Replication Server erases all persistent information.
ds-cfg-replication-server: array ds-cfg-replication-server

Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.
ds-cfg-replication-server-id: integer(int32)

Read Only: true

Specifies a unique identifier for the Replication Server.
ds-cfg-weight: integer(int32)

Default Value: 1

The weight of the replication server.
ds-cfg-window-size: integer(int32)

Default Value: 100

Specifies the window size that the Replication Server uses when communicating with other Replication Servers.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-port"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-heartbeat-interval":{
            "description":"The maximum period of time that the connection to a peer RS will be considered active. ",
            "readOnly":false,
            "default":"10000ms",
            "type":"string"
        },
        "ds-cfg-degraded-status-threshold":{
            "description":"The number of pending changes as threshold value for putting a directory server in degraded status. ",
            "readOnly":false,
            "default":"5000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-group-id":{
            "description":"The group id for the replication server. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-full-threshold":{
            "description":"Full disk threshold to stop the replication server ",
            "readOnly":false,
            "default":"20 megabytes",
            "type":"string"
        },
        "ds-cfg-replication-db-directory":{
            "description":"The path where the Replication Server stores all persistent information. ",
            "readOnly":true,
            "default":"changelogDb",
            "type":"string"
        },
        "ds-cfg-replication-port":{
            "description":"The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-weight":{
            "description":"The weight of the replication server. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-low-threshold":{
            "description":"Low disk threshold to start purging all persistent information ",
            "readOnly":false,
            "default":"100 megabytes",
            "type":"string"
        },
        "ds-cfg-monitoring-period":{
            "description":"The period between sending of monitoring messages. ",
            "readOnly":false,
            "default":"3000ms",
            "type":"string"
        },
        "ds-cfg-disk-full-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information when the disk space falls below the value specified disk-low-threshold. ",
            "readOnly":false,
            "default":"18000s",
            "type":"string"
        },
        "ds-cfg-assured-timeout":{
            "description":"The timeout value when waiting for assured mode acknowledgments. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-replication-server-id":{
            "description":"Specifies a unique identifier for the Replication Server. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-queue-size":{
            "description":"Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain. ",
            "readOnly":false,
            "default":"10000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-handshake-timeout":{
            "description":"Specifies the handshake-timeout interval for the handshake between the replication servers. ",
            "readOnly":false,
            "default":"4000ms",
            "type":"string"
        },
        "ds-cfg-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information. ",
            "readOnly":false,
            "default":"360000s",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the Replication Server uses when communicating with other Replication Servers. ",
            "readOnly":false,
            "default":"100",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : controls

Type: array

LDAP controls to be sent to server for the LDAP operation.

Show Source

Array of: string

{
    "description":"LDAP controls to be sent to server for the LDAP operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : requiredAttributes

Type: array

List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

Show Source

Array of: string

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-replication-server

Type: array

Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.

Show Source

Array of: string

{
    "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Replication Server SuccessResponse

Type: object

Show Source

compareResult: boolean

Indicates the result of LDAP compare operation.
msgType(required): string

Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]

The REST message type
searchResultEntries(required): array searchResultEntries

Number of search result entries returned after the LDAP operation.
totalResults(required): integer(int32)

Specifies the number of entries created, and returned.

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse"
            ]
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/Replication Server SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Replication Server SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Replication Server SearchResultEntry"
    }
}

Nested Schema : Replication Server SearchResultEntry

Type: object

Show Source

attributes(required): object Replication Server Properties
dn(required): string

LDAP DN of the entry to be created

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Replication Server Properties"
        }
    }
}

Nested Schema : Replication Server Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-assured-timeout: string

Default Value: 1000ms

The timeout value when waiting for assured mode acknowledgments.
ds-cfg-degraded-status-threshold: integer(int32)

Default Value: 5000

The number of pending changes as threshold value for putting a directory server in degraded status.
ds-cfg-disk-full-replication-purge-delay: string

Default Value: 18000s

The time (in seconds) after which the Replication Server erases all persistent information when the disk space falls below the value specified disk-low-threshold.
ds-cfg-disk-full-threshold: string

Default Value: 20 megabytes

Full disk threshold to stop the replication server
ds-cfg-disk-low-threshold: string

Default Value: 100 megabytes

Low disk threshold to start purging all persistent information
ds-cfg-group-id: integer(int32)

Default Value: 1

The group id for the replication server.
ds-cfg-handshake-timeout: string

Default Value: 4000ms

Specifies the handshake-timeout interval for the handshake between the replication servers.
ds-cfg-heartbeat-interval: string

Default Value: 10000ms

The maximum period of time that the connection to a peer RS will be considered active.
ds-cfg-monitoring-period: string

Default Value: 3000ms

The period between sending of monitoring messages.
ds-cfg-queue-size: integer(int32)

Default Value: 10000

Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain.
ds-cfg-replication-db-directory: string

Read Only: true

Default Value: changelogDb

The path where the Replication Server stores all persistent information.
ds-cfg-replication-port(required): integer(int32)

The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.
ds-cfg-replication-purge-delay: string

Default Value: 360000s

The time (in seconds) after which the Replication Server erases all persistent information.
ds-cfg-replication-server: array ds-cfg-replication-server

Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.
ds-cfg-replication-server-id: integer(int32)

Read Only: true

Specifies a unique identifier for the Replication Server.
ds-cfg-weight: integer(int32)

Default Value: 1

The weight of the replication server.
ds-cfg-window-size: integer(int32)

Default Value: 100

Specifies the window size that the Replication Server uses when communicating with other Replication Servers.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-port"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-heartbeat-interval":{
            "description":"The maximum period of time that the connection to a peer RS will be considered active. ",
            "readOnly":false,
            "default":"10000ms",
            "type":"string"
        },
        "ds-cfg-degraded-status-threshold":{
            "description":"The number of pending changes as threshold value for putting a directory server in degraded status. ",
            "readOnly":false,
            "default":"5000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-group-id":{
            "description":"The group id for the replication server. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-full-threshold":{
            "description":"Full disk threshold to stop the replication server ",
            "readOnly":false,
            "default":"20 megabytes",
            "type":"string"
        },
        "ds-cfg-replication-db-directory":{
            "description":"The path where the Replication Server stores all persistent information. ",
            "readOnly":true,
            "default":"changelogDb",
            "type":"string"
        },
        "ds-cfg-replication-port":{
            "description":"The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-weight":{
            "description":"The weight of the replication server. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-low-threshold":{
            "description":"Low disk threshold to start purging all persistent information ",
            "readOnly":false,
            "default":"100 megabytes",
            "type":"string"
        },
        "ds-cfg-monitoring-period":{
            "description":"The period between sending of monitoring messages. ",
            "readOnly":false,
            "default":"3000ms",
            "type":"string"
        },
        "ds-cfg-disk-full-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information when the disk space falls below the value specified disk-low-threshold. ",
            "readOnly":false,
            "default":"18000s",
            "type":"string"
        },
        "ds-cfg-assured-timeout":{
            "description":"The timeout value when waiting for assured mode acknowledgments. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-replication-server-id":{
            "description":"Specifies a unique identifier for the Replication Server. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-queue-size":{
            "description":"Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain. ",
            "readOnly":false,
            "default":"10000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-handshake-timeout":{
            "description":"Specifies the handshake-timeout interval for the handshake between the replication servers. ",
            "readOnly":false,
            "default":"4000ms",
            "type":"string"
        },
        "ds-cfg-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information. ",
            "readOnly":false,
            "default":"360000s",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the Replication Server uses when communicating with other Replication Servers. ",
            "readOnly":false,
            "default":"100",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ds-cfg-replication-server

Type: array

Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.

Show Source

Array of: string

{
    "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

201 Response

Created

Root Schema : Replication Server ADDResponse

Type: object

Show Source

msgType(required): string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

The REST message type
searchResultEntries(required): array searchResultEntries
totalResults(required): integer(int32)

Specifies the number of entries created, and returned.

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Replication Server SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

Array of: object Replication Server SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Replication Server SearchResultEntry"
    }
}

Nested Schema : Replication Server SearchResultEntry

Type: object

Show Source

attributes(required): object Replication Server Properties
dn(required): string

LDAP DN of the entry to be created

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Replication Server Properties"
        }
    }
}

Nested Schema : Replication Server Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-assured-timeout: string

Default Value: 1000ms

The timeout value when waiting for assured mode acknowledgments.
ds-cfg-degraded-status-threshold: integer(int32)

Default Value: 5000

The number of pending changes as threshold value for putting a directory server in degraded status.
ds-cfg-disk-full-replication-purge-delay: string

Default Value: 18000s

The time (in seconds) after which the Replication Server erases all persistent information when the disk space falls below the value specified disk-low-threshold.
ds-cfg-disk-full-threshold: string

Default Value: 20 megabytes

Full disk threshold to stop the replication server
ds-cfg-disk-low-threshold: string

Default Value: 100 megabytes

Low disk threshold to start purging all persistent information
ds-cfg-group-id: integer(int32)

Default Value: 1

The group id for the replication server.
ds-cfg-handshake-timeout: string

Default Value: 4000ms

Specifies the handshake-timeout interval for the handshake between the replication servers.
ds-cfg-heartbeat-interval: string

Default Value: 10000ms

The maximum period of time that the connection to a peer RS will be considered active.
ds-cfg-monitoring-period: string

Default Value: 3000ms

The period between sending of monitoring messages.
ds-cfg-queue-size: integer(int32)

Default Value: 10000

Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain.
ds-cfg-replication-db-directory: string

Read Only: true

Default Value: changelogDb

The path where the Replication Server stores all persistent information.
ds-cfg-replication-port(required): integer(int32)

The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.
ds-cfg-replication-purge-delay: string

Default Value: 360000s

The time (in seconds) after which the Replication Server erases all persistent information.
ds-cfg-replication-server: array ds-cfg-replication-server

Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.
ds-cfg-replication-server-id: integer(int32)

Read Only: true

Specifies a unique identifier for the Replication Server.
ds-cfg-weight: integer(int32)

Default Value: 1

The weight of the replication server.
ds-cfg-window-size: integer(int32)

Default Value: 100

Specifies the window size that the Replication Server uses when communicating with other Replication Servers.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-port"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-heartbeat-interval":{
            "description":"The maximum period of time that the connection to a peer RS will be considered active. ",
            "readOnly":false,
            "default":"10000ms",
            "type":"string"
        },
        "ds-cfg-degraded-status-threshold":{
            "description":"The number of pending changes as threshold value for putting a directory server in degraded status. ",
            "readOnly":false,
            "default":"5000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-group-id":{
            "description":"The group id for the replication server. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-full-threshold":{
            "description":"Full disk threshold to stop the replication server ",
            "readOnly":false,
            "default":"20 megabytes",
            "type":"string"
        },
        "ds-cfg-replication-db-directory":{
            "description":"The path where the Replication Server stores all persistent information. ",
            "readOnly":true,
            "default":"changelogDb",
            "type":"string"
        },
        "ds-cfg-replication-port":{
            "description":"The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-weight":{
            "description":"The weight of the replication server. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-low-threshold":{
            "description":"Low disk threshold to start purging all persistent information ",
            "readOnly":false,
            "default":"100 megabytes",
            "type":"string"
        },
        "ds-cfg-monitoring-period":{
            "description":"The period between sending of monitoring messages. ",
            "readOnly":false,
            "default":"3000ms",
            "type":"string"
        },
        "ds-cfg-disk-full-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information when the disk space falls below the value specified disk-low-threshold. ",
            "readOnly":false,
            "default":"18000s",
            "type":"string"
        },
        "ds-cfg-assured-timeout":{
            "description":"The timeout value when waiting for assured mode acknowledgments. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-replication-server-id":{
            "description":"Specifies a unique identifier for the Replication Server. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-queue-size":{
            "description":"Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain. ",
            "readOnly":false,
            "default":"10000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-handshake-timeout":{
            "description":"Specifies the handshake-timeout interval for the handshake between the replication servers. ",
            "readOnly":false,
            "default":"4000ms",
            "type":"string"
        },
        "ds-cfg-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information. ",
            "readOnly":false,
            "default":"360000s",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the Replication Server uses when communicating with other Replication Servers. ",
            "readOnly":false,
            "default":"100",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ds-cfg-replication-server

Type: array

Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.

Show Source

Array of: string

{
    "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

204 Response

No content

406 Response

Not Acceptable

Root Schema : ErrorResponse

Type: object

Show Source

ldapErrorCode: integer(int32)

Specifies the LDAP error code returned for the operation.
message(required): string

Error message returned returned for the operation.
msgType(required): string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

The REST message type

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}