MENU
    Sign cloud storage URLs
    • 04 Mar 2025
    • 1 Minute to read
    • Contributors

    Sign cloud storage URLs


    Article summary

    Post
    /signURLs

    Sign cloud storage URLs. Signed URLs are valid for three hours

    Requires the urls:sign API key scope.

    Security
    HTTP
    Type basic

    Access to the Tulip API requires the use of HTTP Basic Authentication using the credentials of an active Tulip API Token. All requests require the Authorization HTTP header with the Basic scheme to provide API credentials unless otherwise noted.

    API tokens can be configured with a set of scopes which determine what parts of the API that specific token has access to. Security best practices dictate that API credentials be given the minimum set of capabilities required to fulfill their intended purpose. For example, an API token created for use in an integration that is only designed to use the Tables API should probably only be given the tables:read and tables:write scopes. In this way you can minimize risk in the event that API credentials are compromised. API endpoints will document what API token scopes are required to access that endpoint in their descriptions. If a request is made to an endpoint with an API token which does not have the required scopes, the response will be an authorization error.

    Body parameters

    An object containing an array of URLs to sign

    object
    Example{ "urls": [ "https://s3.amazonaws.com/tulip/logo.png", "https://tulip.co" ] }
    urls
    Array of string Required

    The URLs to sign

    string
    Responses
    200

    An object containing an array of the signed URLs. URLs are returned in the order in which they were recieved. URLs that could not be signed are returned as null.

    object
    Example{ "signedURLs": [ "https://s3.amazonaws.com/tulip/logo.png?X-Amz-Signed-Stuff=signedstuff", null ] }
    signedURLs
    Array

    The signed URLs. null values indicate that the URL could not be signed.

    OneOf
    string
    string
    null
    null
    400

    The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.

    object
    errorCode
    string
    errorUniqueID
    string
    Pattern^[a-zA-Z0-9+/]+$
    Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
    details
    string
    401

    The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.

    object
    errorCode
    string
    errorUniqueID
    string
    Pattern^[a-zA-Z0-9+/]+$
    Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
    details
    string
    403

    The provided authentication info was rejected. The response will provide additional details.

    object
    errorCode
    string
    errorUniqueID
    string
    Pattern^[a-zA-Z0-9+/]+$
    Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
    details
    string
    500

    The server encountered an unexpected error.

    object
    errorCode
    string
    errorUniqueID
    string
    Pattern^[a-zA-Z0-9+/]+$
    Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
    details
    string

    Was this article helpful?