CRD REST API Overview
Learn how to connect to the CRD API, authenticate, and follow a typical schedule execution flow.
What the API is for
The CRD REST API lets an application work with schedules in a CRD installation. The reference documents operations for folders, schedules, package records, execution, destinations, and scheduler status. Use the API Reference for the exact request and response contract of each operation.
Supported software
The supported software version is the latest version.
Connect and authenticate
Use the base address configured for your CRD API service. Preserve the exact endpoint path casing shown in the reference. Client credentials are exchanged at /api/OAuth2/token; CRD user authentication uses /api/Login/token. Send the returned token as Authorization: Bearer
A typical execution flow
Check API connectivity with GET /api/Service/Ping.
Obtain a token using the authentication method configured for your integration.
Identify an existing schedule you are authorized to run.
Call POST /api/Schedule/ExecuteScheduleAsync and retain the returned ExecutionId.
Check execution status and verify the outcome separately from request acceptance.
Keep identifiers distinct
A schedule ID identifies a saved schedule. An ExecutionId identifies one asynchronous run. A ProcessId identifies an operating-system process for the termination operation. Use the identifier required by each operation; they are not interchangeable.
Use the operation reference
Each API Reference page is the source of truth for its HTTP method, path, authentication, parameters, request body, and response. Some responses are dynamic. Do not infer a request body from a different schedule type.
Open the CRD API Reference
Updated about 4 hours ago