Sign a URL
post
/v1/url/sign

For security reasons URLs redirecting back to the application must be signed to prevent tampering. This endpoint signs a URL and returns the signed URL. For singing the URL the environment's API key is used. That allows validating the signature on the client side as well. * * The URL must point to the same host as the return URL of the current session's token, because the signature is created with the environment's API key. Any other host is rejected with a 422. * * The signed URL carries an additional expires query parameter, a unix timestamp covered by the signature. Verify the signature as documented and reject URLs whose expires lies in the past.

🔐 Authentication
X-TOKEN Token generated for a UI session
Header parameter: X-TOKEN
📤 Request

Content Type: application/json
url string required

The URL to sign including all query parameters. Must be on the same host as the return URL of the current session's token.

Example: https://example.com?foo=bar&baz=qux
Request Example
📥 Response
200 Successfull
Content Type:
401 Unauthorized Error
Content Type:
422 Unprocessable Entity
Content Type:
500 Internal Server Error
Content Type:
Response Examples