Explore

APIs

ℹ️

API Overview⁠

⁠

System Settings > Server UI > General > URL Configuration > Web API Address

Made up of 6 APIs

Subscription API: Endpoints for users to interact with subscriptions, workflows, and schedules (jobs).

User V2 API: Endpoints for users to interact with credentials, input files, and schedules (jobs).

Admin V1 API: Endpoints for admins to fetch resources from the Admin interface.

Admin V2 API: Version 2 of the endpoints for admins to fetch resources from the Admin interface.

⁠

Admin V3 API⁠

: Version 3 of the endpoints. This version uses OAuth 2.

User V3 API: Version 3 of the endpoints for users. This version uses OAuth 2.

Reference documents are available in swagger

Question mark > API Documentation

OR http(s)://serverhostname.domain/webapi/swagger

Authentication

Enable API in server admin interface, users can obtain key and secret from their profile

Paste API key and secret in swagger and select any API operation, then authenticate

Non-Curator users can access Subscription API and User V2 API

Auditlog endpoint: returns audit event records that document changes to workflows, credentials, collections, subscriptions, users, usergroups

GET /admin/v1/auditlog/

parameters: entity, page, pagesize

Inputfiles endpoint: to run workflows that use the file browse tool via the API

⁠

Migratable endpoint: to migrate workflows across server environments

step 1: get list of workflows ready to migrate

GET api/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/

step 2: download workflows

GET api/admin/v1/{appID}/package/

step 3: publish workflows

POST api/admin/v1/workflows/

step 4: reset migration to “no” in the source environment

PUT api/admin/v1/workflows/migratable/{appID}/

Want to print your doc?
This is not the way.

Try clicking the ··· in the right corner or using a keyboard shortcut (

CtrlP

) instead.