REST API
Getting Started
Custom Domains are an advanced feature that allows businesses to elevate their brand and enhance their professional secret sharing experience for their clients.
Sure, here's a conversion of your HTML to markdown:
API Overview
*BETA API - updated 2022-01-14
Base URI
https://onetimesecret.com/api
All API access is over HTTPS and starts with /api. All responses are JSON.
Authentication
https://USERNAME:[email protected]/api
We use HTTP Basic Authentication for all requests and require a username and password.
- The username is the same as your 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.