REQUEST PASSWORD RESET

RESET YOUR PASSWORD

OK
forgot password?
CANCEL
SHOW API DOCS NAV

REST API

Basics

How the API works Getting Started

Object Properties

Types Coordinates Colors Components Generic Components Line Groups Areas Icons Images Widgets

Meta Data

Adding Displaying Searching Selectors

API Endpoints

Documents

List Get Details Get Content Set Content Create Empty Add Collaborator Change Title Clone Delete

Objects

List Get By Id Get By Selector Create Update Update Multiple Update By Selector Delete

Folders

Create List Change Title Delete

Embeds

Create Static Embed Delete Static Embed Enable Live Embed

Auto Diagram Creation

Request Format Margins, Paddings & Co Components Connections Arrows Groups Nested Groups Tiers Labels Styling Meta Data

IDF Property Reference

Common Properties Component Generic Component Group Connection Image Frame

Image Creation

From Document From CSV or JSON

API Key

Create List Get Details Delete

Enterprise

Requirements

Executable Image Server Operating System Hardware Database Load Balancer

Setup & Deployment

Installation Configuration Deployment

Authentication

Types Steps Configuration

SSO Integration

How it works Login Form Enabling Webhook Auth Authenticating Users Permissioning Document Access Permissioning Access to Embeds

Azure Active Directory

Configuration iFrame integration LocalStorage Passing Token …via Query String …via Post Message Key Parameter

Groups & Permissions

Introduction Key Concepts Relationships Installation Getting Started Managing Groups Managing Users Assigning Groups to Docs Assigning Groups to Embeds

Server-Side Rendering

How it works Caveats Installation Configuration Stability

Service & Logging

Installation Interacting with the Service Uninstalling Running Multiple Instances Logging to File Logging to Event-Viewer

Arcentry Development

Setup

Prerequisites Installation ...Frontend ...Backend Database Setup Configuration Starting the Server Accessing the App

Architecture Overview

State

Structure Manipulation

Backend & Server

Request Processing Access Control Publish Subscribe Building Executable External Dependencies Testing

Frontend Overview

Structure Object Graph

Frontend Rendering

2D Drawing When does drawing happen?

API Docs

Arcentry has a powerful HTTP API that allows you to create, manipulate and delete objects on your diagrams. Any change is reflected in realtime in the app.

This is useful to:

  • Automatically document infrastructure
  • Monitor complex deployments
  • Programmatically create embeds for wikis and blog posts
  • Add metrics to your infrastructure
  • Visualize Scaling Groups
  • Show problems in their context

How the API works

Arcentry's API follows classic REST paradigms. It has two concepts:

  • A document (doc) is any diagram in your application. Each document is identified by a unique id - you can find your document's ID in the API tab in the sidebar Arcentry API Panel Screenshot
  • An object (obj) is any item on a diagram. That includes components such as databases, servers or custom components as well as line groups, icons, areas, labels or images. Each object has a unique id within its document. If you've enabled the API you can find an object's id in the API section of its properties panel. ObjectId location

Getting started

Arcentry's API is disabled by default. You can enable it in the API panel on the sidebar. This will create a unique API key. This API key has to be included in every request, either as a URL parameter

https://arcentry.com/api/v1/doc/cbd59b18-6adf-4f18-b6bc-ef1eb715f62c?key=1IP84UTvzJKds1Jomx8gIbTXcEEJSUilGqpxCcmnx

or as a bearer authorization header

Authorization : Bearer 1IP84UTvzJKds1Jomx8gIbTXcEEJSUilGqpxCcmnx

Please don't hardcode your key

As with all passwords and API keys - please don't hardcode this key in your code or commit it to your Github or similar repo. Instead use environment variables or a secure key store such as AWS Secrets Manager, Google Cloud Key Management Service or Azure Key Vault.

JSON only

Arcentry's API expects all POST requests to send JSON data with a header of 'application/json'. Form-data requests are not supported.