cURL

cURL is a command line tool used to transfer data download data from or to a server using one of the supported protocols, such as FTP, HTTPS, SSH, and so forth. It uses a simple URL to access your system data and therefore may result in security risks. If you decide that using cURL is best for your organization, be sure to pay adequate attention to securing this connection.

If you do not have experience using cURL, the recommended best practice is to use the available features from the interface instead of using cURL. For example, use the available Data Download report interface rather than using the URL syntax available using cURL.

URLs created for a cURL connection do not expire once created. However, you can contact your CXone Account Representative to enable the automatic invalidation of a previously generated URL when the creator's user account is deactivated. If you do not enable this functionality, the connection remains functional when you deactivate the creating user.

It is critical to protect these URLs from usage outside of your control. If you would like to restrict or completely disable this feature for your tenantClosed High-level organizational grouping used to manage technical support, billing, and global settings for your CXone environment, contact your CXone Account Representative for assistance.

Key Facts about cURL

  • When running the cURL command in cmd, use the "-k" modifier in front of the URL for the system to output your file.
  • When writing a batch script to run in the command line, percent signs (%) are interpreted as variables and do not escape into the URL properly. To correct this issue, you must add an additional percent sign (%) before each instance in the URL. For example, if the end of the URL was "...c4EoQ%3d%3d&", you would add additional percent signs like so: "...c4EoQ%%3d%%3d&".
  • If you deactivate the CXone user account of the user who created the cURL connection, the connection will remain functioning; deactivating CXone user accounts does not affect the functionality of cURL connections.
  • You can find many sources online from which to download cURL. Be cautious and ensure that the download is safe. Downloads may also provide instructions for setting up cURL.

Generate Data Download Reports Using cURL

Required permissions: Data Download View

If you do not have experience using cURL, use the data download report interface rather than cURL.

  1. Click the app selector and select Reporting.

  2. Go to Data Downloads  >  Data Download.

  3. Select a report from the list of available reports.
  4. Set your preferred options such as date and time format.
  5. Click Generate cURL.
  6. Copy the code from the text area and paste it in your chosen location.