This page describes important callouts for each endpoint responsible for creating and managing shares.

Create a share

  • All fields are optional when creating a share. However, to create transfers you must set a source and to send transfers you must set a destination location.

Update a share

  • If you have created a transfer prior to adding a destination, you must select a destination that corresponds with the transfer type.
    • If you create a table transfer, you must add a warehouse storage destination.
    • If you create a file transfer, you must add a file storage destination.

Revoke access to a share

  • To revoke access identifier(s) from a share, update the accessIdentifiers array to a new array with the removed access identifier(s).

Important callouts

  • Please note that for destinations to Azure, generate secrets against the Bobsled managed application in the API is not currently supported. You may configure access to Consumer managed applications in the API.

Get a share

  • If you are looking to get information about a share’s current configurations or metadata such as when the share was created and last updated, use this endpoint to return this information.
  • Currently, retrieving archived shares is not supported.

List all shares

  • If you are looking to get all the shares in your account, use this endpoint to return a list of all your shares.
  • Currently, retrieving archived shares is not supported.