API Reference

The secret API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Errors
200 - OK Everything worked as expected.
201 - Resource Created The resource was created as expected.
202 - Request Accepted The request has been accepted for processing, but the processing has not been completed.
204 - Resource Deleted The resource was deleted as expected.
400 - Bad Request The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized No valid API key or user credentials provided. Also the result of an expired token.
402 - Request Failed The parameters were valid but the request failed.
403 - Forbidden The API key or user credentials doesn't have permissions to perform the request.
404 - Not Found The requested resource doesn't exist.
409 - Conflict The request conflicts with another request.
429 - Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 - Server Errors Something went wrong on our end.

Create Secret

POST /guest-api/secret/create
The create object request
{
    "content": "This is my secret content",
    "passphrase": "test"
    "expires": "1 day"
}
The create object response
"https://secretsender.io/guest/viewSecret/f0aae120-d2fe-11eb-8b03-f23c92525f45"

Content string

The secret content to be sent to your recipient.

Passphrase string

Encryption pepper used to secure the secret.

Expires string optional

Lifetime of the secret, defaults to 14 days. Valid values include:

  • 14 days
  • 7 days
  • 3 days
  • 1 day
  • 12 hours
  • 4 hours
  • 1 hour
  • 30 minutes
  • 5 minutes