Cyera API v1 Reference

The Cyera DSR Intake API (v1) is built to enable customers and integration partners to programmatically create and manage privacy requests from anywhere. Whether originating from a web or mobile application or a bulk upload through a script, you can create a DSR in the Cyera platform from wherever you see fit.

Base URL

All API routes use the same base URL consisting of your organization's Cyera URL and the API version:

https://${yourCyeraDomain}/api/v1

For example, if your Cyera URL is camelot.privacy.cyera.io, each endpoint will be preceded with:

https://camelot.privacy.cyera.io/api/v1

Authentication

API keys are used to authenticate requests to the Cyera API. To request an API key, reach out to your Cyera Customer Success Engineer or email us at support@cyera.io.

Authentication to the API is performed by passing your API key in the Authorization header using the Bearer Scheme: Authorization: Bearer <api_key>

All API requests must be made over HTTPS.

Test Your Credentials

To confirm your credentials are valid, send a GET request to the /ping endpoint.

A successful response will be an empty request with status 200

Shell

curl -i "https://${yourCyeraDomain}/api/v1/ping" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <api_key>"

Ruby

require 'HTTParty'
base_url = 'https://${yourCyeraDomain}/api/v1'
HTTParty.get("#{base_url}/ping", headers: { 'Authorization' => "Bearer #{api_key}" })

Python

import requests
base_url = 'https://${yourCyeraDomain}/api/v1'
requests.get('{}/ping'.format(base_url), headers = { 'Authorization': 'Bearer {}'.format(api_key) })