{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/security:rivery/list-dataframes":{"get":{"operationId":"security_rivery_list_dataframes","summary":"Get Dataframes","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/dataframes","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"description":"The number of items per page in the paginated list.","schema":{"type":"integer","default":20,"description":"The number of items per page in the paginated list."}},{"name":"page","in":"query","required":false,"description":"The current page number in the paginated list.","schema":{"type":"integer","default":1,"description":"The current page number in the paginated list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/add-dataframe":{"post":{"operationId":"security_rivery_add_dataframe","summary":"Add Dataframe","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/dataframes","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","body"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/get-dataframe":{"get":{"operationId":"security_rivery_get_dataframe","summary":"Get Dataframe","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"dataframe_name","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/update-dataframe":{"post":{"operationId":"security_rivery_update_dataframe","summary":"Update Dataframe","description":"PUT /v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","dataframe_name","body"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"dataframe_name":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/delete-dataframe":{"post":{"operationId":"security_rivery_delete_dataframe","summary":"Delete Dataframe","description":"DELETE /v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","dataframe_name"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"dataframe_name":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/download-dataframe":{"get":{"operationId":"security_rivery_download_dataframe","summary":"Download Dataframe","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}/download","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"dataframe_name","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/dataframes-clear-values":{"post":{"operationId":"security_rivery_dataframes_clear_values","summary":"Clear Dataframe Values","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}/clear","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","dataframe_name"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"dataframe_name":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-statistics":{"get":{"operationId":"security_rivery_activities_get_statistics","summary":"Get Activities Statistic","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/activities_statistics","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_time","in":"query","required":true,"description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"end_time","in":"query","required":true,"description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"status","in":"query","required":false,"description":"A list of statuses to filter","schema":{"type":"array","description":"A list of statuses to filter"}},{"name":"group_id","in":"query","required":false,"description":"The ID of the group to filter","schema":{"type":"array","description":"The ID of the group to filter"}},{"name":"is_scheduled","in":"query","required":false,"description":"A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned","schema":{"type":"string","enum":["true","false"],"description":"A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned"}},{"name":"search","in":"query","required":false,"description":"Get statistics for rivers that has the search query in their name","schema":{"type":"string","description":"Get statistics for rivers that has the search query in their name"}},{"name":"river_type","in":"query","required":false,"description":"The river type","schema":{"type":"array","description":"The river type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-river-activities-statistic":{"get":{"operationId":"security_rivery_activities_get_river_activities_statistic","summary":"Get River Activities Statistic","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_statistics","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_time","in":"query","required":true,"description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"end_time","in":"query","required":true,"description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"status","in":"query","required":false,"schema":{"type":"array"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-river-activity-targets":{"get":{"operationId":"security_rivery_activities_get_river_activity_targets","summary":"Get River Activities Targets","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_targets","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_time","in":"query","required":true,"description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"end_time","in":"query","required":true,"description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"run_group_id","in":"query","required":false,"description":"Filter by the run group ID","schema":{"type":"string","description":"Filter by the run group ID"}},{"name":"sub_river_id","in":"query","required":false,"description":"Filter by the sub river ID","schema":{"type":"string","description":"Filter by the sub river ID"}},{"name":"status","in":"query","required":false,"description":"A list of statuses. Only targets with those statuses will be returned","schema":{"type":"array","description":"A list of statuses. Only targets with those statuses will be returned"}},{"name":"sort_by","in":"query","required":false,"description":"Indicates by which parameter to sort the targets","schema":{"type":"string","enum":["units","last_run","table_name"],"description":"Indicates by which parameter to sort the targets"}},{"name":"sort_order","in":"query","required":false,"description":"Sorting can be either asc or desc, used in the api-service","schema":{"type":"string","enum":["desc","asc"],"description":"Sorting can be either asc or desc, used in the api-service"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-list-run-groups":{"get":{"operationId":"security_rivery_activities_list_run_groups","summary":"List River Activities Run Groups","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_run_groups","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_time","in":"query","required":true,"description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"end_time","in":"query","required":true,"description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"target_name","in":"query","required":false,"description":"Filter by the target table name","schema":{"type":"string","description":"Filter by the target table name"}},{"name":"sub_river_id","in":"query","required":false,"description":"Filter by the sub river ID","schema":{"type":"string","description":"Filter by the sub river ID"}},{"name":"status","in":"query","required":false,"description":"A list of statuses. Only run groups with this statuses will be returned.","schema":{"type":"array","description":"A list of statuses. Only run groups with this statuses will be returned."}},{"name":"cache_context_id","in":"query","required":false,"description":"Cache context id is an internal query parameter for cache purposes","schema":{"type":"string","description":"Cache context id is an internal query parameter for cache purposes"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1}},{"name":"sort_by","in":"query","required":false,"description":"Activities sort properties in the UI.","schema":{"type":"string","enum":["units","last_run","max_duration"],"description":"Activities sort properties in the UI."}},{"name":"sort_order","in":"query","required":false,"description":"Sorting can be either asc or desc, used in the api-service","schema":{"type":"string","enum":["desc","asc"],"description":"Sorting can be either asc or desc, used in the api-service"}},{"name":"items_per_page","in":"query","required":false,"schema":{"type":"integer","default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-run-group":{"get":{"operationId":"security_rivery_activities_get_run_group","summary":"Get River Activities Run Groups","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_run_groups/{run_group_id}","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"run_group_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-sub-river-activities":{"get":{"operationId":"security_rivery_activities_get_sub_river_activities","summary":"Get River Activities Sub Rivers","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_sub_rivers","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_time","in":"query","required":true,"description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"end_time","in":"query","required":true,"description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"target_name","in":"query","required":false,"description":"Filter by the target table name","schema":{"type":"string","description":"Filter by the target table name"}},{"name":"run_group_id","in":"query","required":false,"description":"Filter by the run group ID","schema":{"type":"string","description":"Filter by the run group ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-river-runs":{"get":{"operationId":"security_rivery_activities_get_river_runs","summary":"Get River Activities Runs","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_time","in":"query","required":true,"description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"end_time","in":"query","required":true,"description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"target_name","in":"query","required":false,"description":"Filter by the target table name","schema":{"type":"string","description":"Filter by the target table name"}},{"name":"run_group_id","in":"query","required":false,"description":"Filter by the run group ID","schema":{"type":"string","description":"Filter by the run group ID"}},{"name":"sub_river_id","in":"query","required":false,"description":"Filter by the sub river ID","schema":{"type":"string","description":"Filter by the sub river ID"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1}},{"name":"items_per_page","in":"query","required":false,"schema":{"type":"integer","default":20}},{"name":"sort_by","in":"query","required":false,"description":"Indicates by which parameter to sort the runs","schema":{"type":"string","enum":["units","start_time","table_name"],"description":"Indicates by which parameter to sort the runs"}},{"name":"sort_order","in":"query","required":false,"description":"Sorting can be either asc or desc, used in the api-service","schema":{"type":"string","enum":["desc","asc"],"description":"Sorting can be either asc or desc, used in the api-service"}},{"name":"cache_context_id","in":"query","required":false,"description":"Cache context id is an internal query parameter for cache purposes","schema":{"type":"string","description":"Cache context id is an internal query parameter for cache purposes"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-river-activities-run":{"get":{"operationId":"security_rivery_activities_get_river_activities_run","summary":"Get River Activities Run","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"run_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-logic-steps-status":{"get":{"operationId":"security_rivery_activities_get_logic_steps_status","summary":"Get River Activities Run Logic Steps","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logic_steps","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"run_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-run-variables":{"get":{"operationId":"security_rivery_activities_get_run_variables","summary":"Get Activities Logic Variables","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/variables","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"run_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-logic-step-logs":{"get":{"operationId":"security_rivery_activities_get_logic_step_logs","summary":"Get Activities Logic Step Log","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logic_steps/{step_id}/logs","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"run_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"step_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"iteration_number","in":"query","required":false,"description":"The step iteration number","schema":{"type":"integer","default":0,"description":"The step iteration number"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/get-activities":{"get":{"operationId":"security_rivery_get_activities","summary":"Get Activities","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/activities","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_time","in":"query","required":true,"description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"end_time","in":"query","required":true,"description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"status","in":"query","required":false,"schema":{"type":"array"}},{"name":"group_id","in":"query","required":false,"description":"The ID of the group to filter","schema":{"type":"array","description":"The ID of the group to filter"}},{"name":"is_scheduled","in":"query","required":false,"description":"A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned","schema":{"type":"string","enum":["true","false"],"description":"A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1}},{"name":"items_per_page","in":"query","required":false,"schema":{"type":"integer","default":20}},{"name":"cache_context_id","in":"query","required":false,"description":"Cache context id is an internal query parameter for cache purposes","schema":{"type":"string","description":"Cache context id is an internal query parameter for cache purposes"}},{"name":"search","in":"query","required":false,"description":"Search for a specific river by river name","schema":{"type":"string","description":"Search for a specific river by river name"}},{"name":"sort_by","in":"query","required":false,"description":"Activities sort properties in the UI.","schema":{"type":"string","enum":["river_name","last_run","units"],"description":"Activities sort properties in the UI."}},{"name":"sort_order","in":"query","required":false,"description":"Sorting can be either asc or desc, used in the api-service","schema":{"type":"string","enum":["desc","asc"],"description":"Sorting can be either asc or desc, used in the api-service"}},{"name":"river_type","in":"query","required":false,"description":"The river type","schema":{"type":"array","description":"The river type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/activities-get-run-logs":{"get":{"operationId":"security_rivery_activities_get_run_logs","summary":"Get Run Logs","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logs","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"run_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/rivers-list-versions":{"get":{"operationId":"security_rivery_rivers_list_versions","summary":"List River Versions","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"description":"The number of items per page in the paginated list.","schema":{"type":"integer","default":20,"description":"The number of items per page in the paginated list."}},{"name":"page","in":"query","required":false,"description":"The current page number in the paginated list.","schema":{"type":"integer","default":1,"description":"The current page number in the paginated list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/rivers-get-version":{"get":{"operationId":"security_rivery_rivers_get_version","summary":"Get River Version","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions/{version_id}","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"version_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/get-river":{"get":{"operationId":"security_rivery_get_river","summary":"Get River","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/edit-river":{"post":{"operationId":"security_rivery_edit_river","summary":"Edit River","description":"PUT /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id","body"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/delete-river":{"post":{"operationId":"security_rivery_delete_river","summary":"Delete River","description":"DELETE /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/list-rivers":{"get":{"operationId":"security_rivery_list_rivers","summary":"List Rivers","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The current page number in the paginated list.","schema":{"type":"integer","default":1,"description":"The current page number in the paginated list."}},{"name":"items_per_page","in":"query","required":false,"description":"The number of items per page in the paginated list.","schema":{"type":"integer","default":20,"description":"The number of items per page in the paginated list."}},{"name":"group_name","in":"query","required":false,"description":"The river group name","schema":{"type":"string","description":"The river group name"}},{"name":"group_id","in":"query","required":false,"description":"The river group id","schema":{"type":"array","description":"The river group id"}},{"name":"name","in":"query","required":false,"description":"The river name","schema":{"type":"string","description":"The river name"}},{"name":"schedule","in":"query","required":false,"description":"The river schedule status","schema":{"type":"string","enum":["all","scheduled","unscheduled"],"description":"The river schedule status"}},{"name":"river_status","in":"query","required":false,"description":"The river status","schema":{"type":"array","description":"The river status"}},{"name":"sort_by","in":"query","required":false,"description":"The river sort by filter","schema":{"type":"string","enum":["last_updated_at","source_name","river_name","group_name","group_id"],"description":"The river sort by filter"}},{"name":"sort_order","in":"query","required":false,"description":"The river sort order filter","schema":{"type":"string","enum":["desc","asc"],"description":"The river sort order filter"}},{"name":"river_type","in":"query","required":false,"description":"The river type","schema":{"type":"array","description":"The river type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/add-river":{"post":{"operationId":"security_rivery_add_river","summary":"Add River","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/rivers","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","body"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/rivers-get-cdc-config":{"get":{"operationId":"security_rivery_rivers_get_cdc_config","summary":"Get Cdc Config","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/rivers-set-cdc-config":{"post":{"operationId":"security_rivery_rivers_set_cdc_config","summary":"Set Cdc Config","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id","body"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/rivers-delete-cdc-config":{"post":{"operationId":"security_rivery_rivers_delete_cdc_config","summary":"Delete Cdc Config","description":"DELETE /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/rivers-cancel-run":{"post":{"operationId":"security_rivery_rivers_cancel_run","summary":"Cancel River Run","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cancel_run","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id","body"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/run-river":{"post":{"operationId":"security_rivery_run_river","summary":"Run River","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/run","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"},"run_sub_rivers":{"type":"boolean","default":false,"description":"A flag that indicates whether to run all active sub rivers of the master river"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/rivers-trigger-sub-river-run":{"post":{"operationId":"security_rivery_rivers_trigger_sub_river_run","summary":"Run Sub River","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/sub_rivers/{sub_river_id}/run","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id","sub_river_id"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"},"sub_river_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/rivers-get-variables":{"get":{"operationId":"security_rivery_rivers_get_variables","summary":"Get River Variables","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/variables","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"river_cross_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"items_per_page","in":"query","required":false,"description":"The number of items per page in the paginated list.","schema":{"type":"integer","default":20,"description":"The number of items per page in the paginated list."}},{"name":"page","in":"query","required":false,"description":"The current page number in the paginated list.","schema":{"type":"integer","default":1,"description":"The current page number in the paginated list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/rivers-update-river-variable":{"post":{"operationId":"security_rivery_rivers_update_river_variable","summary":"Update River Variable","description":"PUT /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/variables","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["river_cross_id","account_id","environment_id","body"],"properties":{"river_cross_id":{"type":"string"},"account_id":{"type":"string"},"environment_id":{"type":"string"},"items_per_page":{"type":"integer","default":20,"description":"The number of items per page in the paginated list."},"page":{"type":"integer","default":1,"description":"The current page number in the paginated list."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/list-environments":{"get":{"operationId":"security_rivery_list_environments","summary":"List Environments","description":"GET /v1/accounts/{account_id}/environments","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"is_deployable_environments","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"items_per_page","in":"query","required":false,"description":"The number of items per page in the paginated list.","schema":{"type":"integer","default":20,"description":"The number of items per page in the paginated list."}},{"name":"page","in":"query","required":false,"description":"The current page number in the paginated list.","schema":{"type":"integer","default":1,"description":"The current page number in the paginated list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/add-environment":{"post":{"operationId":"security_rivery_add_environment","summary":"Add Environment","description":"POST /v1/accounts/{account_id}/environments","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","body"],"properties":{"account_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/get-environment":{"get":{"operationId":"security_rivery_get_environment","summary":"Get Environment","description":"GET /v1/accounts/{account_id}/environments/{environment_id}","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/patch-environment":{"post":{"operationId":"security_rivery_patch_environment","summary":"Patch Environment","description":"PUT /v1/accounts/{account_id}/environments/{environment_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","body"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/delete-environment":{"post":{"operationId":"security_rivery_delete_environment","summary":"Delete Environment","description":"DELETE /v1/accounts/{account_id}/environments/{environment_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/accounts-get-scim-provisioning-status":{"get":{"operationId":"security_rivery_accounts_get_scim_provisioning_status","summary":"Get Scim Provisioning Status","description":"GET /v1/accounts/{account_id}/scim_provisioning","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/accounts-add-or-update-scim-provisioning":{"post":{"operationId":"security_rivery_accounts_add_or_update_scim_provisioning","summary":"Add Or Update Scim Provisioning","description":"PUT /v1/accounts/{account_id}/scim_provisioning","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id"],"properties":{"account_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/accounts-delete-scim-provisioning":{"post":{"operationId":"security_rivery_accounts_delete_scim_provisioning","summary":"Delete Scim Provisioning","description":"DELETE /v1/accounts/{account_id}/scim_provisioning","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id"],"properties":{"account_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/audit-events-list":{"get":{"operationId":"security_rivery_audit_events_list","summary":"List Audit Events","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/audit_events","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_time","in":"query","required":false,"description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm","schema":{"type":"string","description":"The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm"},"example":"2020-01-01T12:00:00"},{"name":"end_time","in":"query","required":false,"description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm If end_time is supplied without start_time the…","schema":{"type":"string","description":"The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm If end_time is supplied without start_time the…"},"example":"2020-01-01T12:00:00"},{"name":"user_id","in":"query","required":false,"description":"A list of users id's who initiated the event","schema":{"type":"array","description":"A list of users id's who initiated the event"},"example":"5eda28ee6b028e1ce7a2b5ed"},{"name":"event_type","in":"query","required":false,"description":"A list of entity types","schema":{"type":"array","description":"A list of entity types"}},{"name":"entity_type","in":"query","required":false,"description":"A list of event types","schema":{"type":"array","description":"A list of event types"}},{"name":"entity_logical_key","in":"query","required":false,"description":"A unique logical identifier of an entity, usually the cross_id","schema":{"type":"string","description":"A unique logical identifier of an entity, usually the cross_id"},"example":"5eda28ee6b028e1ce7a2b5ec"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/audit-events-get-by-id":{"get":{"operationId":"security_rivery_audit_events_get_by_id","summary":"Get Audit Event","description":"GET /v1/accounts/{account_id}/environments/{environment_id}/audit_events/{event_id}","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"environment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"event_id","in":"query","required":true,"description":"The id of the audit event","schema":{"type":"string","description":"The id of the audit event"},"example":"eac285a5a9ae4ada9ccd49889a651e16"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/delete-connection":{"post":{"operationId":"security_rivery_delete_connection","summary":"Delete Connection","description":"DELETE /v1/accounts/{account_id}/environments/{environment_id}/connections/{connection_cross_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","connection_cross_id"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"connection_cross_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/list-teams":{"get":{"operationId":"security_rivery_list_teams","summary":"List Teams","description":"GET /v1/accounts/{account_id}/teams","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1}},{"name":"items_per_page","in":"query","required":false,"schema":{"type":"integer","default":20}},{"name":"display_name","in":"query","required":false,"description":"The internal display name of the team","schema":{"type":"string","description":"The internal display name of the team"},"example":"Marketing team"},{"name":"source","in":"query","required":false,"description":"The team source local (rivery) or external (Active Directory)","schema":{"type":"string","description":"The team source local (rivery) or external (Active Directory)"},"example":"rivery"},{"name":"remote_display_name","in":"query","required":false,"description":"The remote display name of the team","schema":{"type":"string","description":"The remote display name of the team"},"example":"Core team"},{"name":"sort_by","in":"query","required":false,"description":"Sorted the results by attributes","schema":{"type":"string","enum":["display_name","created_at","source","is_all_environment_admin"],"description":"Sorted the results by attributes"}},{"name":"sort_order","in":"query","required":false,"description":"Sorting can be either asc or desc, used in the api-service","schema":{"type":"string","enum":["desc","asc"],"description":"Sorting can be either asc or desc, used in the api-service"}},{"name":"team_id","in":"query","required":false,"description":"List of team ids","schema":{"type":"array","description":"List of team ids"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/create-team":{"post":{"operationId":"security_rivery_create_team","summary":"Create Team","description":"POST /v1/accounts/{account_id}/teams","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","body"],"properties":{"account_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/get-team":{"get":{"operationId":"security_rivery_get_team","summary":"Get Team","description":"GET /v1/accounts/{account_id}/teams/{team_id}","tags":["security"],"parameters":[{"name":"account_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/update-team":{"post":{"operationId":"security_rivery_update_team","summary":"Update Team","description":"PUT /v1/accounts/{account_id}/teams/{team_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["team_id","account_id","body"],"properties":{"team_id":{"type":"string"},"account_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/patch-team":{"post":{"operationId":"security_rivery_patch_team","summary":"Patch Team","description":"PATCH /v1/accounts/{account_id}/teams/{team_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["team_id","account_id","body"],"properties":{"team_id":{"type":"string"},"account_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/delete-team":{"post":{"operationId":"security_rivery_delete_team","summary":"Delete Team","description":"DELETE /v1/accounts/{account_id}/teams/{team_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","team_id"],"properties":{"account_id":{"type":"string"},"team_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/copy-river":{"post":{"operationId":"security_rivery_copy_river","summary":"Copy River","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/copy","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/restore-river":{"post":{"operationId":"security_rivery_restore_river","summary":"Restore River Version","description":"PUT /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/restore","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id","body"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/enable-cdc":{"post":{"operationId":"security_rivery_enable_cdc","summary":"Enable Cdc","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/enable_cdc","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/disable-cdc":{"post":{"operationId":"security_rivery_disable_cdc","summary":"Disable Cdc","description":"POST /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/disable_cdc","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","environment_id","river_cross_id"],"properties":{"account_id":{"type":"string"},"environment_id":{"type":"string"},"river_cross_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:rivery/beta-endpoints-get-predefined-columns":{"get":{"operationId":"security_rivery_beta_endpoints_get_predefined_columns","summary":"Get Predefined Columns","description":"GET /v1/predefined_metadata/columns","tags":["security"],"parameters":[{"name":"datasource_id","in":"query","required":true,"description":"The datasource of the columns.","schema":{"type":"string","enum":["mysql","postgresql","oracle","mongodb","shopify","facebook ads"],"description":"The datasource of the columns."},"example":"shopify"},{"name":"report","in":"query","required":true,"description":"The report id","schema":{"type":"string","description":"The report id"},"example":"orders"},{"name":"column_name","in":"query","required":false,"description":"Name of the column to filter","schema":{"type":"string","description":"Name of the column to filter"},"example":"id"},{"name":"items_per_page","in":"query","required":false,"description":"The number of items per page in the paginated list.","schema":{"type":"integer","default":20,"description":"The number of items per page in the paginated list."}},{"name":"page","in":"query","required":false,"description":"The current page number in the paginated list.","schema":{"type":"integer","default":1,"description":"The current page number in the paginated list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/beta-endpoints-list-predefined-tables":{"get":{"operationId":"security_rivery_beta_endpoints_list_predefined_tables","summary":"Get Predefined Tables","description":"GET /v1/predefined_metadata/tables","tags":["security"],"parameters":[{"name":"datasource_id","in":"query","required":true,"description":"The datasource of the columns.","schema":{"type":"string","enum":["mysql","postgresql","oracle","mongodb","shopify","facebook ads"],"description":"The datasource of the columns."},"example":"shopify"},{"name":"report_name","in":"query","required":false,"description":"Name of the report to filter","schema":{"type":"string","description":"Name of the report to filter"},"example":"orders"},{"name":"items_per_page","in":"query","required":false,"description":"The number of items per page in the paginated list.","schema":{"type":"integer","default":20,"description":"The number of items per page in the paginated list."}},{"name":"page","in":"query","required":false,"description":"The current page number in the paginated list.","schema":{"type":"integer","default":1,"description":"The current page number in the paginated list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/beta-endpoints-get-predefined-metadata":{"get":{"operationId":"security_rivery_beta_endpoints_get_predefined_metadata","summary":"Get Predefined Metadata","description":"GET /v1/predefined_metadata/metadata","tags":["security"],"parameters":[{"name":"datasource_id","in":"query","required":true,"description":"The datasource of the columns.","schema":{"type":"string","enum":["mysql","postgresql","oracle","mongodb","shopify","facebook ads"],"description":"The datasource of the columns."},"example":"shopify"},{"name":"report_id","in":"query","required":true,"description":"The report id","schema":{"type":"string","description":"The report id"},"example":"predefined_orders"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:rivery/beta-endpoints-get-source-metadata":{"get":{"operationId":"security_rivery_beta_endpoints_get_source_metadata","summary":"Get Source Metadata","description":"GET /v1/river_source/metadata","tags":["security"],"parameters":[{"name":"source_name","in":"query","required":true,"description":"The source name","schema":{"type":"string","enum":["mysql","postgresql","oracle","mongodb","shopify","facebook ads"],"description":"The source name"},"example":"shopify"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}