The Certyn REST API lets you manage projects, environments, wiki memory, processes, tests, runs, issues, API keys, CI flows, and outgoing webhooks programmatically.

CI/CD integrations

For GitHub Actions, use GitHub Actions. For other pipeline systems, use the CI Runs API.

Base URL

Use your API host. For Certyn Cloud examples, this is:

https://api.certyn.io

Authentication

Certyn supports:

Bearer tokens (user sessions)
API keys (CI/CD and server-to-server)

API keys are sent as:

curl -H "X-API-Key: cyn_live_<...>" https://api.certyn.io/api/projects

Pagination

Many list endpoints return a paged result:

{
  "items": [],
  "totalCount": 0,
  "page": 1,
  "pageSize": 20,
  "totalPages": 0,
  "hasNextPage": false,
  "hasPreviousPage": false
}

Query parameters typically use page and pageSize.

Errors

Errors use a simple shape:

{ "error": "Human readable message", "details": "Optional details" }

Rate limits

Rate limiting is enforced per tenant (or per IP for unauthenticated requests). Typical limits:

Global: 100 requests/min
API reads: 60 requests/min
Create operations: 20 requests/min

For polling endpoints, use 10-30 second intervals.

Reference sections

Projects API

Create, update, and delete projects.

Environments API

Manage target environments and configuration.

Processes API

Define suites, triggers, and executions.

Test Cases API

Create and execute reusable tests.

Issues API

Work with issue records and retesting flows.

Agents & Sessions API

Inspect runtime sessions and live artifacts.

API Keys API

Create and revoke automation credentials.

CI Runs API

Trigger and monitor Certyn from pipelines.

Webhooks API

MCP Tool Catalog

Connect to Certyn over remote MCP and call the supported verification tools.

API Overview