API Overview

BETA API - updated 2017-04-27 (Have a question?)

Base URI

https://onetimesecret.com/api

All API access is over HTTPS and starts with /api. All responses are JSON.

Authentication

https://USERNAME:APITOKEN@onetimesecret.com/api

We use HTTP Basic Authentication for all requests and require a username and password.

  • The username is the same as your Stella account login.
  • The password is the API token which you can find on your account page.

System Status

GET https://onetimesecret.com/api/v1/status

Current status of the system.

Parameters
None
$ curl -u 'USERNAME:APITOKEN' https://onetimesecret.com/api/v1/status
{"status":"nominal"}

Attributes
  • status: The current system status. One of: nominal, offline.