Skip to main content
The ACB exposes its functionality through a REST API at a single base URL, authenticated with a per-user Refresh Token, Client ID / Client Secret which are exchanged for short-lived Access Tokens. This page covers everything that’s shared across endpoints — base URL, authentication mechanics, status codes, rate limits. Per-endpoint detail lives on each endpoint page.
NOT AVAILABLE IN SAAS. ACB is on-premises only.

Base URL

All endpoints share the same base URL:
Replace <hostname> with the computer name where the ACB service is installed.
For ACB deployments updated from a version prior to 1.2, the URL prefix is EkranACB instead of SytecaACB. Use https://<hostname>/EkranACB/... exactly in scripts targeting those installs.

Authentication

ACB uses a two-step authentication model: a long-lived Client ID / Client Secret is exchanged for a short-lived Access Token, and the Access Token authenticates subsequent API calls.
Migrate to Client ID / Client Secret authentication before the three-month transition period ends if Refresh Token has been used before.

1. Get the Client ID / Client Secret

The Client ID and Client Secret are generated per user in the Management Tool — see Set up user account for the procedure. Once you have it, store it securely (treat it like a username and password).

2. Exchange Client ID / Client Secret for Access Token

Call POST /SytecaACB/api/token with the Client ID and Client Secret in the body. The response includes the Access Token, its token_type and expires_in lifetime (in seconds).

3. Use the Access Token on subsequent calls

Pass Access Token in the Authorization header when making requests to endpoints v1.3+ (folders, secrets, bulk, user management).
string
The Access Token returned by api/token. Format: pass raw token value in the header using the format Bearer <token>.
When the Access Token expires (default: 15 minutes — see Access Token Lifetime), call api/token again with the same Client ID and Client Secret to get a new one.

Status codes

Rate limiting

Different endpoint groups have different rate limits. Exceeding the limit returns HTTP 429 Too Many Requests with a Retry-After header indicating when to retry.
Rate limits are evaluated per Access Token, which is per Refresh Token, which is per Management Tool user. Multiple parallel automation consumers sharing one user account share the same rate budget.

Endpoints

Old endpoints (pre-v1.3, still supported)

Authentication

Folder endpoints

Secret endpoints

Bulk action

User Management and Admin Password Rotation

User Management endpoints (9) and Admin Password Rotation endpoints (2) — covered in Phase 2 of this batch, navigation links to come.

Overview

What the ACB API is and when to use it.

Data models

Schemas shared across request and response bodies.

Set up user account

Configure a user with the Refresh Token.

CLI reference

SytecaACBConsole.exe — command-line wrapper.