HomeGuidesAPI ReferenceChangelog
Log In
API Reference

API Basics

The Arcadia Switch REST APIs provide simple RESTful interfaces with lightweight JSON-formatted responses.

This section of the documentation is geared toward developers and covers the basics of using any of our Switch REST API endpoints.

  • Authentication - How to authenticate yourself, with examples of various technologies.
  • REST Request - How to send a request including the domains, paths, and HTTP Method conventions we use. Also includes details on the common parameters for pagination, filtering, and sorting.
  • REST Response - We have a standard response wrapper, which is detailed here. We also talk about HTTP status codes and how we return error messages.
  • Date Formats - Dates and times can be tricky...
  • Tools & Helper Libraries - Some recommendations for tools that can help with developing and running applications that include our APIs and our Java Client Library, plus other languages, bindings, and helpers.
  • Versioning and Releases - How we version APIs and how to request extended fields etc.
  • Echo Endpoint - A simple set of APIs for testing your integration.