sensitivity.io REST API Reference (v1)

Download OpenAPI specification: Download

Contact: team@sensitivity.io

To find out more about sensitivity.io, please visit our website at https://sensitivity.io

sensitivity.io REST Services API is used by clients and third party apps to interact with our web services.

API version 1 (v1) is stable as of 2018-03-01

We provide and maintain C, C++, C#, Java, PHP and Golang SDKs for working with our API. They can be downloaded from your Control Panel.

Support

Support is available as a service and is already part of your subscription. Please find out more at sensitivity.io Support.

For any questions on API, please join our sensitivity.io community.

Bug reports in the documentation or the API are welcome, but please follow our Responsible Disclosure guide.

sensitivity.io is offering Data Loss Prevention SDK for Cloud, Apps, and Services. Powerful REST API and SaaS offering can Inject security, DLP features & HIPAA, GDPR and other compliance policies at the core of your apps.

Add DLP, scanning and classification to your apps with DLP Windows SDK, DLP Linux SDK, DLP Mac SDK, DLP iOS or Android SDK.

integrations

Integrating sensitivity.io SDK in your applications, services or infrastructure

Mobile platforms integration

sdks

The easiest way to interact with sensitivity.io Web Service API is through a language specific SDK.

Documentation for integration

https://developers.sensitivity.io/integration/index.html

Official SDKs

* sensitivity.io Python SDK

Platform Specific SDKs

Community SDKs

authentication

Access

API access is through HTTPS requests at api.sensitivity.io.

Requests

Requests are of Content-Type application/json, multipart/form-data or application/x-www-form-urlencoded.

Responses

Responses are always of Content-Type application/json.

Additional Header

If not specified otherwise, always make the request with an additional header Host with value api.sensitivity.io

Authorization

The authentication method for sesitivity.io API is by using an authentication HTTP Header with the either the special keyword Auth-Key or OAuth2 protocol.

  • API Key
  • OAuth2

Examples assume your API Service is located at https://api.sensitivity.io

curl -X GET \
  https://api.sensitivity.io/v1/accounts/92683310********/projects/2c******/apps/045ad58*******/ \
    -H 'Auth-Key: 52ae895c286d44d3****************' \
    -H 'Content-Type: application/json' \
    -H 'Host: api.sensitivity.io'

On success, the response will contain a valid response.

HTTP/1.1 200 OK
Date: Mon, 25 Aug 2017 08:00:00 GMT
Content-Type: application/json
Content-Length: 501
Etag: 1.0.1.045ad585ad5a99da.1503667039393.0
X-Request-Id: ef82d5fe-fa57-47a9-a214-7515e003751d
X-Version-Id: 1.0.1.054243338249840c0ebc2e1b23021bd7
X-Kong-Upstream-Latency: 5
X-Kong-Proxy-Latency: 0
Via: kong/0.10.3

{{json object response}}

OAuth2 Provider

sensitivity.io is offering OAuth 2.0 services that can acts as OAuth 2.0 service provider.

curl -X GET \
  https://api.sensitivity.io/v1/accounts/92683310********/projects/2c******/apps/045ad58*******/ \
    -H 'Auth-Key: Bearer 52ae895c286d44d3****************' \
    -H 'Content-Type: application/json' \
    -H 'Host: api.sensitivity.io'

More can be found under the OAuth2 section under this API Reference

accounts

Accounts operations. /my will retrieve the account requesting the authentication, if valid.

Get account

Get account information, based on the authentication details provided during the request.

Parameters
path Parameters ?
account_id
string Required

Account Id

header Parameters ?
Auth-Key
string Required

Auth-Key to access your REST API resources

Host
string Required
"api.sensitivity.io"

Instruct API Gateway to redirect the request to this specific host

Responses

200 Account retrieval successful
Response Schema

400 Invalid or missing parameters in URL or request body
Response Schema

401 No Auth-Key provided
Response Schema

403 Permission denied
Response Schema

404 Not found
Response Schema
get
/accounts/{account_id}/
https://api.sensitivity.io/v1/accounts/{account_id}/
Request samples
  • cURL
  • C/C++
  • C#
  • Java
  • PHP
  • Go
Copy 
curl -X GET \
  https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}} \
  -H 'auth-key: {{AUTH_KEY}}' \
  -H 'host: {{REQUEST_HOST}}' \
  -H 'content-type: application/json'
Copy 
CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "auth-key: {{AUTH_KEY}}");
headers = curl_slist_append(headers, "host: {{REQUEST_HOST}}");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);
Copy 
var client = new RestClient("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}");
var request = new RestRequest(Method.GET);
request.AddHeader("auth-key", "{{AUTH_KEY}}");
request.AddHeader("host", "{{REQUEST_HOST}}");
request.AddHeader("content-type", "application/json");
IRestResponse response = client.Execute(request);
Copy 
HttpResponse<String> response = Unirest.get("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}")
  .header("auth-key", "{{AUTH_KEY}}")
  .header("host", "{{REQUEST_HOST}}")
  .header("content-type", "application/json")
  .asString();
Copy 
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "auth-key: {{AUTH_KEY}}",
    "host: {{REQUEST_HOST}}",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Copy 
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("auth-key", "{{AUTH_KEY}}")
  req.Header.Add("host", "{{REQUEST_HOST}}")
  req.Header.Add("content-type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response samples

  • 200 Account retrieval successful

  • 400 Invalid or missing parameters in URL or request body

  • 401 No Auth-Key provided

  • 403 Permission denied

  • 404 Not found

Copy Expand all Collapse all 
{
  • "id": 0,
  • "api_id": "string",
  • "auth_key": "string",
  • "api_gateway_status": 0,
  • "api_gateway_details": "string",
  • "name": "string",
  • "company_name": "string",
  • "card_verified": false,
  • "email": "string",
  • "currency": "string",
  • "timezone": "string",
  • "invite_id": "string",
  • "is_license_expired": true,
  • "create_at": 0,
  • "update_at": 0,
  • "delete_at": 0
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}

Update account

Update account. Only fields listed bellow in the request body will be updated.

Parameters
path Parameters ?
account_id
string Required

Account Id

header Parameters ?
Auth-Key
string Required

Auth-Key to access your REST API resources

Host
string Required
"api.sensitivity.io"

Instruct API Gateway to redirect the request to this specific host

Request Body

Account to be updated


name
string
company_name
string
display_name
string
email
string
address
string
zip_code
string
country_code
string
phone
string

Responses

200 Account update successful
Response Schema

400 Invalid or missing parameters in URL or request body
Response Schema

401 No Auth-Key provided
Response Schema

403 Permission denied
Response Schema

404 Not found
Response Schema
put
/accounts/{account_id}/
https://api.sensitivity.io/v1/accounts/{account_id}/
Request samples
  • JSON
  • cURL
  • C/C++
  • C#
  • Java
  • PHP
  • Go
Copy Expand all Collapse all 
{
  • "name": "string",
  • "company_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "address": "string",
  • "zip_code": "string",
  • "country_code": "string",
  • "phone": "string"
}
Copy 
curl -X PUT \
  https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/ \
  -H 'Auth-Key: {{AUTH_KEY}}' \
  -H 'Host: {{REQUEST_HOST}}' \
  -H 'Content-Type: application/json' \

  -d '{
    "name": "string",
    "company_name": "string",
    "display_name": "string",
    "email": "string",
    "address": "string",
    "zip_code": "string",
    "country_code": "string",
    "phone": "string",
    "type": "string"
  }'
Copy 
CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Auth-Key: {{AUTH_KEY}}");
headers = curl_slist_append(headers, "Host: {{REQUEST_HOST}}");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"name\": \"string\",\n  \"company_name\": \"string\",\n  \"display_name\": \"string\",\n  \"email\": \"string\",\n  \"address\": \"string\",\n  \"zip_code\": \"string\",\n  \"country_code\": \"string\",\n  \"phone\": \"string\",\n  \"type\": \"string\"\n}");

CURLcode ret = curl_easy_perform(hnd);
Copy 
var client = new RestClient("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/");
var request = new RestRequest(Method.PUT);
request.AddHeader("Auth-Key", "{{AUTH_KEY}}");
request.AddHeader("Host", "{{REQUEST_HOST}}");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("undefined", "{\n  \"name\": \"string\",\n  \"company_name\": \"string\",\n  \"display_name\": \"string\",\n  \"email\": \"string\",\n  \"address\": \"string\",\n  \"zip_code\": \"string\",\n  \"country_code\": \"string\",\n  \"phone\": \"string\",\n  \"type\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Copy 
HttpResponse<String> response = Unirest.put("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/")
.header("Content-Type", "application/json")
.header("Host", "{{REQUEST_HOST}}")
.header("Auth-Key", "{{AUTH_KEY}}")
.body("{\n  \"name\": \"string\",\n  \"company_name\": \"string\",\n  \"display_name\": \"string\",\n  \"email\": \"string\",\n  \"address\": \"string\",\n  \"zip_code\": \"string\",\n  \"country_code\": \"string\",\n  \"phone\": \"string\",\n  \"type\": \"string\"\n}")
.asString();
Copy 
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\n  \"name\": \"string\",\n  \"company_name\": \"string\",\n  \"display_name\": \"string\",\n  \"email\": \"string\",\n  \"address\": \"string\",\n  \"zip_code\": \"string\",\n  \"country_code\": \"string\",\n  \"phone\": \"string\",\n  \"type\": \"string\"\n}",
  CURLOPT_HTTPHEADER => array(
    "Auth-Key: {{AUTH_KEY}}",
    "Content-Type: application/json",
    "Host: {{REQUEST_HOST}}",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Copy 
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/"

  payload := strings.NewReader("{\n  \"name\": \"string\",\n  \"company_name\": \"string\",\n  \"display_name\": \"string\",\n  \"email\": \"string\",\n  \"address\": \"string\",\n  \"zip_code\": \"string\",\n  \"country_code\": \"string\",\n  \"phone\": \"string\",\n  \"type\": \"string\"\n}")

  req, _ := http.NewRequest("PUT", url, payload)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Host", "{{REQUEST_HOST}}")
  req.Header.Add("Auth-Key", "{{AUTH_KEY}}")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response samples

  • 200 Account update successful

  • 400 Invalid or missing parameters in URL or request body

  • 401 No Auth-Key provided

  • 403 Permission denied

  • 404 Not found

Copy Expand all Collapse all 
{
  • "id": 0,
  • "api_id": "string",
  • "auth_key": "string",
  • "api_gateway_status": 0,
  • "api_gateway_details": "string",
  • "name": "string",
  • "company_name": "string",
  • "card_verified": false,
  • "email": "string",
  • "currency": "string",
  • "timezone": "string",
  • "invite_id": "string",
  • "is_license_expired": true,
  • "create_at": 0,
  • "update_at": 0,
  • "delete_at": 0
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}

Get license for account

Get account license as object

Permissions

view_account permission must be allowed to this user.

Parameters
path Parameters ?
account_id
string Required

Account Id

header Parameters ?
Auth-Key
string Required

Auth-Key to access your REST API resources

Host
string Required
"api.sensitivity.io"

Instruct API Gateway to redirect the request to this specific host

Responses

200 License retrieval successful
Response Schema

400 Invalid or missing parameters in URL or request body
Response Schema

401 No Auth-Key provided
Response Schema

403 Permission denied
Response Schema

404 Not found
Response Schema
get
/accounts/{account_id}/license
https://api.sensitivity.io/v1/accounts/{account_id}/license
Request samples
  • cURL
  • C/C++
  • C#
  • Java
  • PHP
  • Go
Copy 
curl -X GET \
  https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license \
  -H 'Auth-Key: {{AUTH_KEY}}' \
  -H 'Content-Type: application/json' \
  -H 'Host: {{REQUEST_HOST}}' \
Copy 
CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Auth-Key: {{AUTH_KEY}}");
headers = curl_slist_append(headers, "Host: {{REQUEST_HOST}}");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);
Copy 
var client = new RestClient("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license");
var request = new RestRequest(Method.GET);
request.AddHeader("Auth-Key", "{{AUTH_KEY}}");
request.AddHeader("Host", "{{REQUEST_HOST}}");
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);
Copy 
HttpResponse<String> response = Unirest.get("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license")
.header("Content-Type", "application/json")
.header("Host", "{{REQUEST_HOST}}")
.header("Auth-Key", "{{AUTH_KEY}}")
.asString();
Copy 
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Auth-Key: {{AUTH_KEY}}",
    "Content-Type: application/json",
    "Host: {{REQUEST_HOST}}",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Copy 
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license"

  payload := strings.NewReader("")

  req, _ := http.NewRequest("GET", url, payload)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Host", "{{REQUEST_HOST}}")
  req.Header.Add("Auth-Key", "{{AUTH_KEY}}")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response samples

  • 200 License retrieval successful

  • 400 Invalid or missing parameters in URL or request body

  • 401 No Auth-Key provided

  • 403 Permission denied

  • 404 Not found

Copy Expand all Collapse all 
[
  • {
    }
]
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}

Add License to account

Import license to this existing account by posting it as string resource

Permissions

manage_account permission must be allowed to this user.

Parameters
path Parameters ?
account_id
string Required

Account Id

header Parameters ?
Auth-Key
string Required

Auth-Key to access your REST API resources

Host
string Required
"api.sensitivity.io"

Instruct API Gateway to redirect the request to this specific host

Request Body

License resource


plan_type
string
validity
integer

Responses

200 Add License successful
Response Schema

400 Invalid or missing parameters in URL or request body
Response Schema

401 No Auth-Key provided
Response Schema

403 Permission denied
Response Schema
post
/accounts/{account_id}/license
https://api.sensitivity.io/v1/accounts/{account_id}/license
Request samples
  • JSON
  • cURL
  • C/C++
  • C#
  • Java
  • PHP
  • Go
Copy Expand all Collapse all 
{
  • "plan_type": "string",
  • "validity": 0
}
Copy 
curl -X POST \
https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license \
-H 'Auth-Key: {{AUTH_KEY}}' \
-H 'Content-Type: application/json' \
-H 'Host: {{REQUEST_HOST}}' \
-d '{
  "plan_type": "string",
  "validity": 365
}'
Copy 
CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Auth-Key: {{AUTH_KEY}}");
headers = curl_slist_append(headers, "Host: {{REQUEST_HOST}}");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"plan_type\": \"string\",\n  \"validity\": <integer>\n}");

CURLcode ret = curl_easy_perform(hnd);
Copy 
var client = new RestClient("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license");
var request = new RestRequest(Method.POST);
request.AddHeader("Auth-Key", "{{AUTH_KEY}}");
request.AddHeader("Host", "{{REQUEST_HOST}}");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("undefined", "{\n  \"plan_type\": \"string\",\n  \"validity\": <integer>\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Copy 
HttpResponse<String> response = Unirest.post("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license")
.header("Content-Type", "application/json")
.header("Host", "{{REQUEST_HOST}}")
.header("Auth-Key", "{{AUTH_KEY}}")
.body("{\n  \"plan_type\": \"string\",\n  \"validity\": <integer>\n}")
.asString();
Copy 
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n  \"plan_type\": \"string\",\n  \"validity\": <integer>\n}",
  CURLOPT_HTTPHEADER => array(
    "Auth-Key: {{AUTH_KEY}}",
    "Content-Type: application/json",
    "Host: {{REQUEST_HOST}}",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Copy 
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/license"

  payload := strings.NewReader("{\n  \"plan_type\": \"string\",\n  \"validity\": <integer>\n}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Host", "{{REQUEST_HOST}}")
  req.Header.Add("Auth-Key", "{{AUTH_KEY}}")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response samples

  • 200 Add License successful

  • 400 Invalid or missing parameters in URL or request body

  • 401 No Auth-Key provided

  • 403 Permission denied

Copy Expand all Collapse all 
{
  • "response": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}

Get account profile

Get account profile

Permissions

view_account permission must be allowed to this user.

Parameters
path Parameters ?
account_id
string Required

Account Id

header Parameters ?
Auth-Key
string Required

Auth-Key to access your REST API resources

Host
string Required
"api.sensitivity.io"

Instruct API Gateway to redirect the request to this specific host

Responses

200 Account profile retrieval successful
Response Schema

400 Invalid or missing parameters in URL or request body
Response Schema

401 No Auth-Key provided
Response Schema

403 Permission denied
Response Schema

404 Not found
Response Schema
get
/accounts/{account_id}/profile
https://api.sensitivity.io/v1/accounts/{account_id}/profile
Request samples
  • cURL
  • C/C++
  • C#
  • Java
  • PHP
  • Go
Copy 
curl -X GET \
https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/profile \
-H 'Auth-Key: {{AUTH_KEY}}' \
-H 'Content-Type: application/json' \
-H 'Host: {{REQUEST_HOST}}' \
Copy 
CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/profile");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Auth-Key: {{AUTH_KEY}}");
headers = curl_slist_append(headers, "Host: {{REQUEST_HOST}}");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);
Copy 
var client = new RestClient("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/profile");
var request = new RestRequest(Method.GET);
request.AddHeader("Auth-Key", "{{AUTH_KEY}}");
request.AddHeader("Host", "{{REQUEST_HOST}}");
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);
Copy 
HttpResponse<String> response = Unirest.get("https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/profile")
.header("Content-Type", "application/json")
.header("Host", "{{REQUEST_HOST}}")
.header("Auth-Key", "{{AUTH_KEY}}")
.asString();
Copy 
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Auth-Key: {{AUTH_KEY}}",
    "Content-Type: application/json",
    "Host: {{REQUEST_HOST}}",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Copy 
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.sensitivity.io/v1/accounts/{{ACCOUNT_ID}}/profile"

  payload := strings.NewReader("")

  req, _ := http.NewRequest("GET", url, payload)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Host", "{{REQUEST_HOST}}")
  req.Header.Add("Auth-Key", "{{AUTH_KEY}}")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response samples

  • 200 Account profile retrieval successful

  • 400 Invalid or missing parameters in URL or request body

  • 401 No Auth-Key provided

  • 403 Permission denied

  • 404 Not found

Copy Expand all Collapse all 
[
  • {
    }
]
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}
Copy Expand all Collapse all 
{
  • "http_code": 0,
  • "code": "string",
  • "message": "string",
  • "details": "string"
}

users

Users operations. /my will retrieve the user requesting the authentication, if valid.

projects

Projects operations.

apps

Apps/installations operations.

protection profiles

A protection profile represents the link between a profile definition and:

  • either a profile origin (account, project or app)
  • or a profile destination (i.e. cloud storage path).

profile definitions

A profile definition consists of:

  • predefined content definitions
  • file type definitions
  • dictionary definitions
  • regex definitions.

The resulting collection is used as an instruction set by the scanner.

profile origins

Profile origins are targets for profile definitions. They can be either accounts, projects or apps.

profile destinations

Target paths in the associated cloud storage accounts. Profile destinations are used either for periodical or one-time scans.

definitions - predefined content

definitions - file types

definitions - dictionaries

definitions - regular expressions

scanner

Interacting with sensitivity.io scanning engine.

cloud services

Interacting with cloud data storage providers.

oauth2

oAuth2 Clients and Service.

preferences

Handling user preferences.

general

General operations.