version 2 (2.4.1)
- uri: api.rou.to/v2
- response formats: json
- capabilities/functions:
- GetRedirect,CreateRedirect,ModifyRedirect general
- outputs/response:
- outcome={success/warning/error}
- message
- data
- #
- domain_id
- domain_name
- domain_contact_email_address (situational)
- domain_enabled
- redirect_tag
- redirect_type
- redirect_target
- redirect_target_trusted
- redirect_expirable
- redirect_deactivated
- redirect_deactivate_datetime
- redirect_modify_datetime
- redirect_insert_datetime
- redirect_target_safety_message (situational)
- notes:
- domain_contact_email_address is only included for authorized integrations
- redirect_type is the HTTP code of the type of redirect (e.g. 307 for temporary, 301 for permanent)
- redirect_target_trusted is used for bypassing recurring security checks on the target and can only be set to 1 (trusted) by RouTo administrators
- redirect_target_safety_message is only included if there's a safety message to provide
- GetRedirect
- permission: public
- method: GET
- inputs:
- domain_id={domain_id}
- domain={domain_name}
- tag={tag}
- notes:
- don't need to provide both domain_id and domain, just one
- if both domain_id and domain are provided, domain_id is used
- CreateRedirect
- permission: private - authorized integrations only
- method: POST
- inputs:
- action=create
- domain_id={domain_id}
- target={url}
- ModifyRedirect
- permission: private - authorized integrations only
- method: POST
- inputs:
- action=modify
- domain_id={domain_id}
- tag={current_tag}
- new_tag={new_tag}
- type={type}
- target={url}
- trusted={0/1}
- expirable={0/1}
- deactivated={0/1}
- CheckTarget
- permission: public
- method: POST
- inputs:
- action=check
- target={url}
- outputs/response:
- outcome={success/warning/error}
- message
- data