POST /disaster_recovery/ariel_copy_profiles/{id}

Updates a Ariel Copy Profile by ID.

Table 1. POST /disaster_recovery/ariel_copy_profiles/{id} resource details
MIME Type
application/json

Table 2. POST /disaster_recovery/ariel_copy_profiles/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	Required. The ID for the Ariel Copy Profile to be updated.
fields	header	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. POST /disaster_recovery/ariel_copy_profiles/{id} request body details
Parameter	Data Type	MIME Type	Description	Sample
arielCopyProfileDTO	Object	application/json	Required. A single Ariel Copy Profile object that has the following modifiable fields: host_id - Long - The ID of the Ariel Copy host. The host_id references the /config/deployment/hosts endpoint. destination_host_ip - String - The IP address of the managed host where the Ariel data is sent. destination_port - Long - The port of the managed host over which the Ariel data is sent. exclude_event_retention_bucket_ids - Array[Long] - The ID of the event retention bucket where events are not copied from. The exclude_event_retention_bucket_id references the /config/event_retention_buckets endpoint. exclude_flow_retention_bucket_ids - Array[Long] - The ID of the flow retention bucket where flow data is not copied from. The exclude_flow_retention_bucket_id references the /config/flow_retention_buckets endpoint. bandwidth_limit - Long - The amount to limit the bandwidth in bytes per second for copying data. enabled - Boolean - Whether Ariel Copy is enabled on the host. The enabled field is set to false by default frequency - Long - The frequency, in milliseconds, that Ariel Copy will run. start_date - Long - The date to start copying Ariel data from. end_date - Long - The date to copy Ariel data up until. Any other set fields will be ignored.	{ "destination_host_ip": "123.123.123.0", "destination_port": 2222, "end_date": 1572490800000, "exclude_flow_retention_bucket_ids": [ 1, 3, 5 ], "bandwidth_limit": 1000, "host_id": 53, "id": 1, "start_date": 1572404400000, "enabled": true, "frequency": 60000, "exclude_event_retention_bucket_ids": [ 2, 4, 6 ] }

Table 4. POST /disaster_recovery/ariel_copy_profiles/{id} response codes
HTTP Response Code	Unique Code	Description
200		The Ariel Copy Profile was updated.
404	1001	The Resource that was requested by the provided id does not exist.
422	1002	A request parameter is not valid.
422	1003	The 'destination_host_ip' is not a valid IP.
422	1004	The 'retention_bucket_id' does not exist.
422	1005	The 'bandwidth_limit' parameter is invalid.
422	1006	The 'host_id' parameter is not a valid host.
422	1007	The 'frequency' parameter is invalid.
422	1008	The 'start_date' parameter is invalid.
422	1009	The 'end_date' parameter is invalid.
422	1010	The 'start_date' parameter is invalid.
422	1011	The 'end_date' parameter is invalid.
422	1012	The 'end_date' can not be before the 'start_date'.
422	1013	The 'port' parameter is invalid.
422	1014	The 'host_id' parameter already exists.
500	1000	An error occurred during the attempt to update the Ariel Copy Profile.

Response Description

The Ariel Copy Profile object containing the following fields:

id - Long - The ID of the Ariel Copy Profile.
host_id - Long - The ID of the Ariel Copy host. The host_id references the /config/deployment/hosts endpoint.
destination_host_ip - String - The IP address of the managed host where the Ariel data is sent.
destination_port - Long - The port of the managed host over which the Ariel data is sent.
exclude_event_retention_bucket_ids - Array[Long] - The ID of the event retention bucket where events are not copied from. The exclude_event_retention_bucket_id references the /config/event_retention_buckets endpoint.
exclude_flow_retention_bucket_ids - Array[Long] - The ID of the flow retention bucket where flow data is not copied from. The exclude_flow_retention_bucket_id references the /config/flow_retention_buckets endpoint.
bandwidth_limit - Long - The amount to limit the bandwidth in bytes per second for copying data.
enabled - Boolean - Whether Ariel Copy is enabled on the host. The enabled field is set to false by default
frequency - Long - The frequency, in milliseconds, that Ariel Copy will run.
start_date - Long - The date to start copying Ariel data from.
end_date - Long - The date to copy Ariel data up until.
last_successful_transfer_ariel_type - Enum - The type of Ariel data transferred during most recent successful transfer. Can be one of: EVENTS_PAYLOAD, EVENTS_RECORD, EVENTS_MD, FLOWS_PAYLOAD, FLOWS_RECORD, FLOWS_MD
last_successful_ariel_content_transferred - Long - The date of the Ariel content transferred during most recent successful transfer
last_successful_transfer_date - Long - The date the most recent successful transfer occurred
last_error_ariel_type - String - The type of Ariel data attempted transferred during most recent error, Can be one of: EVENTS_PAYLOAD, EVENTS_RECORD, EVENTS_MD, FLOWS_PAYLOAD, FLOWS_RECORD, FLOWS_MD
last_error_ariel_content_transferred - Long - The type of Ariel data attempted to be transferred during last unsuccessful transfer
last_error_date - Long - The date the most recent error occurred
last_error_max_threshold_surpassed_date - Long - The most recent date Ariel copy was forced to abort due to error threshold being surpassed

Response Sample


{
    "bandwidth_limit": 42,
    "destination_host_ip": "String",
    "destination_port": 42,
    "enabled": true,
    "end_date": 42,
    "exclude_event_retention_bucket_ids": [
        42
    ],
    "exclude_flow_retention_bucket_ids": [
        42
    ],
    "frequency": 42,
    "host_id": 42,
    "id": 42,
    "last_error_ariel_content_transferred": 42,
    "last_error_ariel_type": "String <one of: EVENTS_PAYLOAD, EVENTS_RECORD, EVENTS_MD, FLOWS_PAYLOAD, FLOWS_RECORD, FLOWS_MD>",
    "last_error_date": 42,
    "last_error_max_threshold_surpassed_date": 42,
    "last_successful_ariel_content_transferred": 42,
    "last_successful_transfer_ariel_type": "String <one of: EVENTS_PAYLOAD, EVENTS_RECORD, EVENTS_MD, FLOWS_PAYLOAD, FLOWS_RECORD, FLOWS_MD>",
    "last_successful_transfer_date": 42,
    "start_date": 42
}