Skip to content
ArcSite ArcSite API

Introduction

Welcome to the ArcSite API 👋

The ArcSite API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

Section titled “Base URL”

All API requests are made to the following base URL:

Terminal window
https://api.arcsite.com/v1

Conventions

Section titled “Conventions”
  • JSON everywhere — Requests and responses are JSON-encoded. Send Content-Type: application/json on any request that has a body.
  • Timestamps — Timestamps are in UTC and use the ISO 8601 format (for example, 2022-01-16T04:19:23).
  • Resource IDs — Resource IDs are large integers and may be returned as JSON strings in some responses. Treat them as opaque identifiers.
  • Status codes — The API uses standard HTTP status codes. See the Errors page for details.
  • Pagination — List endpoints are paginated with the page and per_page parameters. See Pagination for details.
  • Authentication — Requests are authenticated with a bearer token header. See Authentication for details.