Skip to content
English
Log a Support Call Customer portal
  • There are no suggestions because the search field is empty.

How to Install, Configure, and Use the CRD API

Install the CRD API Service, configure API clients, and test the connection before building an integration.

The CRD API lets applications run schedules and manage scheduling operations through HTTP requests. This article covers the service setup. For authentication, request fields, and responses, use the CRD API guides and API Reference.

Before you begin

  • You need access to CRD system options and the Windows credentials required to install the API Service.
  • Use the protocol, server name, and port configured for your installation. Port numbers shown in screenshots are examples.
  • Use an API testing tool such as Postman to test the connection and authentication.

Install and start the API Service

  1. Open CRD and select Options > REST API. The API configuration window opens.
  2. Select Install API. Enter the required Windows credentials and click OK.
  3. Confirm the installation by clicking Yes.
  4. When installation completes, click OK.
  5. Click Start and confirm that the API Service is running.

If the API is already installed, use the same configuration window to review its settings and manage the service.

Configure an API client

Applications can authenticate using OAuth2 client credentials. To create a client:

  1. In the API configuration window, open the API Clients tab.
  2. Click Add and enter a descriptive client name.
  3. Record the generated Client ID and Client Secret securely, then save the client.

Treat the Client Secret as a password. Keep it out of public documentation, source code, screenshots, and logs.

Follow Authentication and Token Management to request a token and send the correct authorization header for your authentication flow.

Test the connection

The Ping endpoint does not require an access token. Send a GET request using your configured server address and port:

GET http://<server>:<port>/api/service/ping

Replace the placeholders with your installation settings and use the configured protocol. A successful response confirms that the API Service is reachable from the system making the request.

If the request fails, check that the API Service is running and that the configured address and port are accessible. If it works on the CRD server but fails from the integration host, check the network and firewall settings.

Run your first schedule

Once authentication and connectivity work, follow Execute a CRD Schedule Through the REST API. Confirm that the CRD Scheduler is running and that the schedule runs successfully in CRD before submitting it through the API.

Get help with an integration

See Troubleshoot the CRD REST API for connection, authentication, request, and execution problems. If you contact Support, include the endpoint, timestamp, sanitized request and response, CRD version, and execution ID if available. Do not include passwords, Client Secrets, active tokens, or confidential report content.

Related CRD API resources