Retrieve Metadata

POST https://onetimesecret.com/api/v1/private/METADATA_KEY

Every secret also has associated metadata. The metadata is intended to be used by the creator of the secret (i.e. not the recipient) and should generally be kept private. You can safely use the metadata key to retrieve basic information about the secret itself (e.g. if or when it was viewed) since the metadata key is different from the secret key.

Query Params

METADATA_KEY: the unique key for this metadata.

Attributes

custid: this is you :]

metadata_key: the unique key for the metadata. DO NOT share this.

secret_key: the unique key for the secret you created. This is key that you can share.

ttl: The time-to-live that was specified (i.e. not the time remaining)

metadata_ttl: The remaining time (in seconds) that the metadata has left to live.

secret_ttl: The remaining time (in seconds) that the secret has left to live.

recipient: if a recipient was specified, this is an obfuscated version of the email address.

created: Time the metadata was created in unix time (UTC)

updated: ditto, but the time it was last updated.

received: Time the secret was received.

passphrase_required: If a passphrase was provided when the secret was created, this will be true. Otherwise false, obviously.