← Back to the RDS Proxy main page
Every function of the RDS Proxy console is available through the Artica REST API. Requests go to the Web API port of the appliance (9503 by default) from an allowed network, or with the Web API key in the X-Auth-Token header. Bodies are JSON objects whose values are strings; responses contain Status, Error and the requested data.
curl -s -H 'X-Auth-Token: <web-api-key>' https://artica.example.com:9503/rdpproxy/stateMethod Path Effect GET /rdpproxy/state Installation, versions, listening port, open sessions, policies, video support GET /rdpproxy/status Service status GET /rdpproxy/restart Restart the gateway (progress in the console)
¶ Members, targets and policiesMethod Path Effect GET / POST /rdpproxy/members List / create members GET / PUT / DELETE /rdpproxy/members/{id} Read / replace / delete a member GET / POST /rdpproxy/targets List / create targets GET / PUT / DELETE /rdpproxy/targets/{id} Read / replace / delete a target (passwords are never returned) POST /rdpproxy/targets/{id}/enable, /disable Enable or disable a target GET / POST /rdpproxy/policies List / create policies GET / PUT / DELETE /rdpproxy/policies/{id} Read / replace / delete a policy (session rights are the allow_* fields) POST /rdpproxy/policies/{id}/enable, /disable Enable or disable a policy POST / DELETE /rdpproxy/policies/{id}/{networks|schedules|members|targets}[/{sub}] Link or unlink a network, schedule, member or target GET / POST /rdpproxy/patterns?policy=N List / create detection patterns (policy=0 for all policies) PUT / DELETE /rdpproxy/patterns/{id} Replace / delete a pattern
¶ Sessions, videos and eventsMethod Path Effect GET /rdpproxy/sessions Open sessions POST /rdpproxy/sessions/{id}/disconnect Disconnect a session GET /rdpproxy/videos Recorded videos DELETE /rdpproxy/videos/{id} Delete a video GET /rdpproxy/events?user=&reason=&limit= Access events (up to 500)
¶ Second factor, SIEM and TLSMethod Path Effect GET /rdpproxy/mfa/users Second-factor users (secrets are never returned) POST /rdpproxy/mfa/reset, /unlock, /exempt Body {"username":"…"} GET /rdpproxy/siem/status SIEM connection state GET / POST /rdpproxy/tls/ciphers Cipher suites offered to the targets
¶ Example: create a member and link it to a policycurl -s -H 'X-Auth-Token: <key>' -X POST https://artica:9503/rdpproxy/members \
-d '{"username":"jsmith","password":"S3cret!","endoflife":"1798761600"}'
# {"Status":true,"Error":"","ID":12}
curl -s -H 'X-Auth-Token: <key>' -X POST https://artica:9503/rdpproxy/policies/1/members \
-d '{"id":"12"}'Every change made through the API is written to the Artica security audit trail.