# List all ReplicationProfiles.

Endpoint: GET /replication-profiles
Version: 3.18.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort results by. A property name with a prepended '-' signifies descending order.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The ReplicationProfile ID.

  - `items.name` (string)
    The ReplicationProfile name.

  - `items.replication_mode` (string)
    The ReplicationProfile mode.
    Enum: "ENGINE_DATA_REPLICATION", "MASKED_DATA_DISTRIBUTION", "CONTINUOUS_VAULT"

  - `items.engine_id` (string)
    The ID of the engine that the ReplicationProfile belongs to.

  - `items.target_engine_id` (string)
    The ID of the replication target engine.

  - `items.target_host` (string)
    Hostname of the replication target engine.

  - `items.target_port` (integer)
    Target TCP port number for the Delphix Session Protocol.

  - `items.type` (string)
    The ReplicationProfile type.

  - `items.description` (string)
    The ReplicationProfile description.

  - `items.last_execution_status` (string)
    The status of the last execution of the ReplicationProfile.
    Enum: "RUNNING", "COMPLETED", "SUSPENDED", "CANCELED", "FAILED"

  - `items.last_execution_status_timestamp` (string)
    The timestamp of the last execution status.

  - `items.schedule` (string)
    Replication schedule in the form of a quartz-formatted string.

  - `items.replication_tag` (string)
    Globally unique identifier for this ReplicationProfile.

  - `items.replication_objects` (array)
    The objects that are replicated by this ReplicationProfile.

  - `items.tags` (array)
    The tags that are applied to this ReplicationProfile.

  - `items.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `items.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `items.enable_tag_replication` (boolean)
    Indicates whether tag replication from primary object to replica object is enabled or disabled for this ReplicationProfile.

  - `items.bandwidth_limit` (integer)
    Bandwidth limit (MB/s) for replication network traffic. A value of 0 means no limit.

  - `items.number_of_connections` (integer)
    Total number of transport connections to use.

  - `items.encrypted` (boolean)
    Encrypt replication network traffic.

  - `items.automatic_replication` (boolean)
    Indication whether the replication spec schedule is enabled or not.

  - `items.use_system_socks_setting` (boolean)
    Connect to the replication target host via the system-wide SOCKS proxy.

  - `items.vdb_ids` (array)
    The VDBs that are replicated by this ReplicationProfile.

  - `items.dsource_ids` (array)
    The dSources that are replicated by this ReplicationProfile.

  - `items.cdb_ids` (array)
    The CDBs that are replicated by this ReplicationProfile.

  - `items.vcdb_ids` (array)
    The vCDBs that are replicated by this ReplicationProfile.

  - `items.group_ids` (array)
    The groups that are replicated by this ReplicationProfile.

  - `items.replicate_entire_engine` (boolean)
    Whether to replicate the entire engine. This is mutually exclusive with the vdb_ids, dsource_ids, cdb_ids, vcdb_ids, and group_ids properties.

  - `items.data_layout_ids` (array)
    The data-layouts that are replicated by this ReplicationProfile.

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.next_cursor` (string)
    Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.

