Introduction

  1. Overview
  2. API
  3. Introduction
API access is limited to subscribers of the "Business" plan.

Our API allows you to gain access to your folders and secrets. You can also create secrets and retrieve the secret link. If you are having problems accessing resources or have anything in mind we should add, let us know at support@inprivy.io

Example: Get a list of all folders

Method: GET

$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';

curl https://inprivy.io/api/folders \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

Rate Limiting

You can make up to 60 requests per minute and 1,440 requests per day per authenticated user. You can check the returned HTTP headers of any API request to see your current per minute rate limit status:

Status: 200 OK
x-ratelimit-limit: 60
x-ratelimit-remaining: 59

If you keep hitting the limit, consider caching the results within your application.

Errors

When we detect an error in your request, we will return a HTTP 4xx response. Most common will be 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden) and 404 (Not Found).

Please note that the response message might give you further details about what went wrong. A message is only returned for requests that resulted with an error. If you aren't receiving errors, but for example a login page, make sure you've set "Accept: application/json" in your request headers.


Was this article helpful?