Pradeo Security API

Appearance

Quick Start ​

This guide will help you make your first API call in just a few minutes.

Prerequisites ​

  • Your access key (from Company page > Access key management subtab)
  • Your secret key (from profile drawer in top right corner)
  • Basic knowledge of HTTP requests

Step 1: Get Your Credentials ​

Access Key:

  1. Navigate to the Company page
  2. Go to the Access key management subtab
  3. Copy your access key

Secret Key:

  1. Click on your profile in the top right corner (profile drawer)
  2. Copy your secret key

Step 2: Make Your First API Call ​

Retrieve your company information:

bash
curl -X GET "https://api.<tenant>.pradeo-security.com/v2/company" \
  -H "x-access-key: YOUR_ACCESS_KEY" \
  -H "x-secret-key: YOUR_SECRET_KEY"

Response:

json
{
  "id": "<company-id>",
  "name": "My business",
  "creationDate": "2024-07-14T14:53:59.354Z",
  "lastModificationDate": "2024-09-05T16:01:02.000Z",
  "address": { ... },
  "selectedResponsePolicy": { ... },
  "deletedAt": null
}

Step 3: Provision Your First Device ​

  1. Create a device group:
bash
curl -X POST "https://api.<tenant>.pradeo-security.com/v2/device-groups" \
  -H "x-access-key: YOUR_ACCESS_KEY" \
  -H "x-secret-key: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My First Group"
  }'

You can pass an externalId parameter at creation to pass your own id.

Troubleshooting ​

Cannot connect to API ​

Check:

  1. Verify your tenant ID is correct
  2. Verify the format: api.<tenant>.pradeo-security.com
  3. Test DNS resolution: nslookup api.<tenant>.pradeo-security.com
  4. Test connectivity: ping api.<tenant>.pradeo-security.com

Wrong credentials error ​

Check:

  1. Verify your access and secret keys are correct
  2. Verify credentials are not expired
  3. Ensure you're using the correct keys for your tenant

Connection timeout ​

Check:

  1. Verify network connectivity
  2. Check if firewall allows outbound HTTPS connections
  3. Verify the endpoint URL is correctly formatted
  4. Try health endpoint to verify server is responding

Next Steps ​