{"openapi":"3.1.0","info":{"title":"share","version":"4"},"servers":[{"url":"https://api.doppler.com"}],"components":{"securitySchemes":{"sec0":{"type":"http","scheme":"basic"}}},"security":[{"sec0":[]}],"paths":{"/v1/share/secrets/plain":{"post":{"summary":"Plain Text","description":"Generate a Doppler Share link by sending a plain text secret. This endpoint is not end-to-end encrypted as you are sending the secret in plain text. At no point do we store the plain text secret or the password in our systems. The receive flow the user goes through will be end-to-end encrypted where the encrypted secret will be decrypted on the browser.","operationId":"share-secret","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["secret"],"properties":{"secret":{"type":"string","description":"Plain text secret to share.","default":"TEST SECRET"},"expire_views":{"type":"integer","description":"Number of views before the link expires. Valid ranges: 1 to 50. -1 for unlimited.","default":1,"format":"int32"},"expire_days":{"type":"integer","description":"Number of days before the link expires. Valid range: 1 to 90.","default":1,"format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"url\": \"https://share.doppler.com/s/oarjigpajqtodoqefoua9o1iisdfaocgfbulmaez\",\n  \"authenticated_url\": \"https://share.doppler.com/s/oarjigpajqtodoqefoua9o1iisdfaocgfbulmaez#GZPgKEngtasgXHftCjimCwjPquZV7qwwzo8qb1m7rgvjlWXFr8C5jHOuXtxW1SBC\",\n  \"password\": \"GZPgKEngtasgXHftCjimCwjPquZV7qwwzo8qb1m7rgvjlWXFr8C5jHOuXtxW1SBC\",\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"url":{"type":"string","example":"https://share.doppler.com/s/oarjigpajqtodoqefoua9o1iisdfaocgfbulmaez"},"authenticated_url":{"type":"string","example":"https://share.doppler.com/s/oarjigpajqtodoqefoua9o1iisdfaocgfbulmaez#GZPgKEngtasgXHftCjimCwjPquZV7qwwzo8qb1m7rgvjlWXFr8C5jHOuXtxW1SBC"},"password":{"type":"string","example":"GZPgKEngtasgXHftCjimCwjPquZV7qwwzo8qb1m7rgvjlWXFr8C5jHOuXtxW1SBC"},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v1/share/secrets/encrypted":{"post":{"summary":"E2E Encrypted","description":"Generate a Doppler Share link by sending an encrypted secret. The receive flow the user goes through will be end-to-end encrypted where the encrypted secret will be decrypted on the browser.","operationId":"share-secret-encrypted","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["encrypted_secret","hashed_password","encryption_kdf","encryption_salt_rounds"],"properties":{"encrypted_secret":{"type":"string","description":"Ecrypted secret using AES-GCM with a symmetric key derived from a cryptographically random 64 character passphrase using PBKDF2. 1,000,000 salt rounds required. Then base64 encode the encrypted secret.","default":"<BASE64 ENCODED, ENCRYPTED SECRET>"},"hashed_password":{"type":"string","description":"SHA256 hash of the password. This is NOT the hash of the derived encryption key.","default":"<SHA256 HASH>"},"expire_views":{"type":"integer","description":"Number of views before the link expires. Valid ranges: 1 to 50. -1 for unlimited.","default":1,"format":"int32"},"expire_days":{"type":"integer","description":"Number of days before the link expires. Valid range: 1 to 90.","default":1,"format":"int32"},"encryption_kdf":{"type":"string","description":"The key derivation function used. Must by \"pbkdf2\".","default":"pbkdf2"},"encryption_salt_rounds":{"type":"integer","description":"Number of salt rounds used by KDF. Must be \"1000000\".","default":1000000,"format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"url\": \"https://share.doppler.com/s/oarjigpajqtodoqefoua9o1iisdfaocgfbulmaez#GZPgKEngtasgXHftCjimCwjPquZV7qwwzo8qb1m7rgvjlWXFr8C5jHOuXtxW1SBC\",\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"url":{"type":"string","example":"https://share.doppler.com/s/oarjigpajqtodoqefoua9o1iisdfaocgfbulmaez#GZPgKEngtasgXHftCjimCwjPquZV7qwwzo8qb1m7rgvjlWXFr8C5jHOuXtxW1SBC"},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":false},"x-readme-fauxas":true}