Skip to main content

API Reference

The Ciphrix API allows you to programmatically interact with the Ciphrix platform to upload evidence and test files for compliance workflows.

Overview​

The Ciphrix API is built using RESTful principles and provides:

  • Secure authentication using Bearer tokens
  • Multipart form data for file uploads
  • Standard HTTP response codes
  • Simple JSON response format

Environments​

Ciphrix API is available in the following environments:

Beta Environment​

https://global.api.beta.ciphrix.app

Available for testing and development purposes.

Production Environment​

Provided upon request

Production API URL will be provided to you by the Ciphrix team after your account is set up.

Authentication​

All requests to the API must include the following HTTP header:

Authorization: Bearer <YOUR_API_KEY>

Example:

Authorization: Bearer cpx_beta_ABCDEFGHJKILKEY

Getting Your API Key​

You can generate and obtain your API key from System Settings → API Keys within the Ciphrix platform.

See the API Setup Guide for detailed instructions on generating your API key.

Response Format​

All responses are returned in JSON format with the following structure:

Success Response​

{
    "status": 200,
    "message": "Files uploaded successfully",
    "data": {
        "no_of_files_uploaded": 2
    }
}

Error Response​

{
    "status": 400,
    "message": "Failed to upload files to evidence"
}

HTTP Status Codes​

The API uses standard HTTP status codes:

  • 200 - OK - Request successful
  • 400 - Bad Request - Invalid request parameters
  • 401 - Unauthorized - Missing or invalid API key
  • 404 - Not Found - Resource not found
  • 500 - Internal Server Error - Server error occurred

API Endpoints​

Available Endpoints​

Need Help?​