IronBox Secure File Transfer

Introduction

IronBox is the easiest and most secure way to exchange sensitive data. With IronBox, you can be sure that your data is being protected with the highest protection available. And it can be used by anyone of any skill level.

The help guides, tutorials and videos provided here will help you get started using IronBox Secure File Transfer.

How to View Videos in Full Screen.

This help page provides instructions and videos on using IronBox. Videos provided are best viewed in high-definition (HD) and in full screen.

Videos are configured to automatically play in HD. To view videos in full screen, click the full screen button shown below. When you're done, press the Esc key to return your screen back to normal size.

Creating a Secure Upload Area (Wizard)

If you need to create an area where your customers can securely upload data to you the IronBox Secure File Transfer Wizard can help you do this.

HOW TO

Log into your IronBox account.
In your Secure File Transfer tab, click the Secure Package Wizard option.
Select the Receive Files Securely button.
Enter a name for your package in the Request Name field.
Enter your customer’s email address in the Email Request To field. Separate multiple emails with a comma (,).
Enter an optional message in the Secure Message area.
Click Send Request. An email (you will be Cc:d) with an Easy Access access Web link will be sent out to the customers emails provided. Instruct your customers to click the link and they will be able to upload data to you securely.
Note that because this is an upload only secure package, no password is required for access.

VIDEO

Tutorial videos are best viewed in full screen and in high-definition (HD).

Adding Your Company Logo (Co-Branding)

IronBox lets you co-brand with your company logo. Co-branding helps keep your company looking sharp and professional. And it lets your customers quickly recognize brands that they already trust and recognize.

HOW TO

Log into your IronBox account.
On the top-right corner, click on your name.
Select Settings
On the General Settings tab, enter the URL of your company logo in the Company Logo URL field.
Note: It is highly recommended that you use an SSL-enabled (i.e. https://) link. Using a non-HTTPS link will trigger security warnings with most modern browsers. If you do not have an HTTPS enabled server, please contact us and we’ll host your image on our secure server for you at no cost.
Click the Save button.

VIDEO

Tutorial videos are best viewed in full screen and in high-definition (HD).

Creating a Secure Exchange Area (Wizard)

The IronBox Secure File Transfer Wizard can help you create a secure package where you and your customers can both upload and download data securely.

HOW TO

Log into your IronBox account.
In your Secure File Transfer tab, click the Secure Package Wizard button.
Select the Send and Receive Files Securely option.
In the New Secure Package Name, enter a name for the secure data exchange area.
In the Password field, enter a strong password to protect the secure data exchange area. Your customers will require this password for access.
In the Email Address(es) field enter the email addresses of your customers. Separate multiple email addresses with a comma (,).
(Optional) Enter your customer’s mobile numbers to SMS text the password to.
(Optional) Enter an optional secure message.
(Optional) Select files from your computer to upload into the new secure package and click the Start Upload button.
Click the Send Files Now button.
An email (you will be Cc:d) with an Easy Access access Web link will be sent out to the customers emails provided. Instruct your customers to click the link and they will be able to exchange data with you securely.

VIDEO

Tutorial videos are best viewed in full screen and in high-definition (HD).

Sending Files Securely (Wizard)

The IronBox Secure File Transfer service can help you send files to your customers securely. If you simply need to send files securely (one-way) the IronBox Secure File Transfer Wizard can help you do this.

HOW TO

Log into your IronBox account.
In your Secure File Transfer tab, click the Secure Package Wizard button.
Select the Send Files Securely option.
In the New Secure Package Name, enter a name for the secure data exchange area.
In the Password field, enter a strong password to protect the secure data exchange area. Your customers will require this password for access.
In the Email Address(es) field enter the email addresses of your customers. Separate multiple email addresses with a comma (,).
(Optional) Enter your customer’s mobile numbers to SMS text the password to.
(Optional) Enter an optional secure message.
(Optional) Select files from your computer to upload into the new secure package and click the Start Upload button.
Click the Send Files Now button.
An email (you will be Cc:d) with an Easy Access access Web link will be sent out to the customers emails provided. Instruct your customers to click the link and they will be able to exchange data with you securely.

VIDEO

Tutorial videos are best viewed in full screen and in high-definition (HD).

Finding Your Easy Access Link

Easy Access is an ideal way for sending sensitive data to users who may not be very technical and/or do not have their own IronBox account. With Easy Access, users simply click a Web link and enter a password (if any) and they have instant access to data you’ve shared with them. Here’s how to get the Easy Access link for any secure package you create with IronBox.

HOW TO

Log into your IronBox account.
Select a secure package.
(Method #1) Click the Share this Secure Package on the right-hand side.
If Easy Access is already enabled on the secure package selected, then there will be a View with Easy Access option. Select this option and copy the URL shown in the browser address bar.
(Method #2) Click the Options button, select Easy Access Settings. The Easy Access will be shown in below in blue.

VIDEO

Tutorial videos are best viewed in full screen and in high-definition (HD).

Official launch soon

REST Clients

REST API clients that implement the methods shown below are available for use and download.

View our GitHub site for more information at https://github.com/IronBox/IronBoxRESTClients.

ContainerKeyData

Returns the symmetric key material for the requested container. A symmetric key (base 64 encoded), initialization vector (base 64 encoded) and a symmetric key strength integer index (0 = none, 1 = AES128, 2 = AES256) is returned. The key strength index will dictate which algorithm to use in conjunction with the symmetric key returned. For example, a key strength response of 2 indicates that AES-256 is used.

Note that all AES encryption operations should use Cipher-Block Chaining (CBC) mode and PKCS7 for padding.

Only the owner or members of a container may execute this request, otherwise a null response is returned. It is recommended that developers take measures to protect container key data while at rest at all times.

POST	https://api.goironcloud.com/{version}/ContainerKeyData

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerID	A 64-bit integer container ID

EXAMPLES

Response

<RESTContainerKeyData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LockBox">
	<SessionIVBase64>DGfFlRKIBpwDNUB0PH8Cbw==</SessionIVBase64>
	<SessionKeyBase64>lFKiKF2o+W/vvLqddOdv2ttxWSUX/SSZEyqcdyDDb+8=</SessionKeyBase64>
	<SymmetricKeyStrength>2</SymmetricKeyStrength>
</RESTContainerKeyData>

Request

The .NET RESTclient will read the container symmetric key data into a ProtectedContainerKeyData object that will automatically protect the symmetric key data in memory using the Microsoft Data Protection API.

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

ProtectedContainerKeyData KeyData = RESTClient.GetContainerKeyData("email@email.com", LockBoxEntityIDType.EmailAddress, "password", 100777);

Request

curl -d "Entity=email@email.com&EntityPassword=password&EntityType=0&ContainerID=100777" https://api.goironcloud.com/latest/ContainerKeyData

Ping

Indicates True of False if the IronBox API service is responding. This method does not require authentication.

GET	https://api.goironcloud.com/{version}/Ping

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

None

EXAMPLES

Response

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

Request

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;
if (RESTClient.ServiceIsResponding())
{
    // API service is ready
}

Request

curl https://api.goironcloud.com/latest/Ping

GetContainerBlobInfoListByState

Returns an array of blob info objects that match the provided state. For example, if a Ready state is provided, then returns the container blob info objects of all blobs that are in the Ready state.

POST	https://api.goironcloud.com/{version}/GetContainerBlobInfoListByState

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerID	A 64-bit integer container ID
BlobState	An integer that represents the blob state to query (0 = blob created, 1 = entity is uploading, 2 = ready, 3 = checked out, 4 = entity is modifying and 5 = None)

EXAMPLES

Response

<restblobinfolist xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LockBox">
        <BlobInfoArray>
            <RESTBlobInfo>
                <BlobID>lbx932013110219pm_5b5120e9</BlobID>
                <BlobName>SensitiveData.pptx</BlobName>
            </RESTBlobInfo>
            <RESTBlobInfo>
                <BlobID>lbx932013110220pm_b4bfcdba</BlobID>
                <BlobName>SSNs.docx</BlobName>
            </RESTBlobInfo>
        </BlobInfoArray>
</restblobinfolist>

Request

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

RESTBlobInfo[] ReadyBlobs = RESTClient.GetEntityContainerBlobInfoListByState("email@email.com", LockBoxEntityIDType.EmailAddress, "password", ContainerID, LockBoxBlobStatusKey.Ready);

Request

curl -d "Entity=email@email.com&EntityType=0&EntityPassword=password&ContainerID=100777&BlobState=2" https://api.goironcloud.com/latest/GetContainerBlobInfoListByState

GetContainerInfoListByContext

Developers can use this method to return a list of container IDs and container names that an entity is a member of by context (e.g., secure.goironcloud.com or demo.goironcloud.com). The entity must already be a member of the context.

POST	https://api.goironcloud.com/{version}/GetContainerInfoListByContext

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
Context	Context (e.g. secure.goironcloud.com or demo.goironcloud.com).
ContainerType	Always set to 5.

EXAMPLES

Response

<RESTContainerInfoList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LockBox">
	<ContainerInfoArray>
		<RESTContainerInfo>
			<ContainerID>100777</ContainerID>
			<ContainerName>Test Container</ContainerName>
		</RESTContainerInfo>
		<RESTContainerInfo>
			<ContainerID>211431</ContainerID>
			<ContainerName>Another container for REST test</ContainerName>
		</RESTContainerInfo>
	</ContainerInfoArray>
</RESTContainerInfoList>

Request

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

RESTContainerInfo[] info = RESTClient.GetContainerInfoListByContext("email@email.com", LockBoxEntityIDType.EmailAddress, "password", "secure.goironcloud.com", 5);

Request

curl -d "Entity=email@email.com&EntityPassword=passsword&EntityType=0&Context=secure.goironcloud.com&ContainerType=5" https://api.goironcloud.com/latest/GetContainerInfoListByContext

GetContainerIDFromFriendlyID

Returns the 64-bit integer container ID for a given container 'friendly' ID, -1 on error (i.e. invalid credentials, unknown friendly ID, etc.).

POST	https://api.goironcloud.com/{version}/GetContainerIDFromFriendlyID

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerFriendlyID	Container friendly ID to resolve to a container ID (example: F759622ABCA647BE)

EXAMPLES

Response

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

Request

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

long ContainerID = RESTClient.GetEntityContainerIDByFriendlyID("email@email.com", LockBoxEntityIDType.EmailAddress, "Password", "F759622ABCA647BE");

Request

curl -d "Entity=email@email.com&EntityType=0&EntityPassword=password&ContainerFriendlyID=1973831D4D5D4225" https://api.goironcloud.com/latest/GetContainerIDFromFriendlyID

GetContainerIDsFromName

Returns an comma separated string of 64-bit integer containers IDs that match the container name provided. Only IDs for containers that the calling entity is an owner or member of will be returned.

POST	https://api.goironcloud.com/{version}/GetContainerIDsFromName

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerName	The name of the container

EXAMPLES

Response

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">10074,100777</string>

Request

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

long[] ContainerIDs = RESTClient.GetContainerIDsFromName("email@email.com", LockBoxEntityIDType.EmailAddress, "password", "test");

Request

curl -d "Entity=email@email.com&EntityType=0&EntityPassword=password&ContainerName=container_name" https://api.goironcloud.com/latest/GetContainerIDsFromName

ReadEntityContainerBlob

Retrieves the storage information required to read encrypted entity container blobs directly from storage. Returned information will include storage endpoint URL, container name and a shared access signature that grants limited temporary access to back-end storage.

Callers can then use the URL specified in the SharedAccessSignatureUri response to directly read the encrypted blob from storage.

Once downloaded, callers must then decrypt the encrypted blob using the information provided from the call to ContainerKeyData.

POST	https://api.goironcloud.com/{version}/ReadEntityContainerBlob

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerID	A 64-bit integer container ID
BlobIDName	A string that denotes the blob ID

EXAMPLES

Response

<RESTBlobReadData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LockBox">
	<ContainerStorageName>lbxe9155a5e68ea4b14ae79096008e9cfca</ContainerStorageName>
	<SharedAccessSignature>?se=2013-09-04T21%3A19%3A45Z&amp;sr=b&amp;sp=r&amp;sig=U31IOEwu2%2Bc69oc%2BFv2pXTec29zspUWYqZKLRtf3MBo%3D</SharedAccessSignature>
	<SharedAccessSignatureUri>https://storagedomain.blob.core.windows.net/lbxe9155a5e68ea4b14ae79096008e9cfca/lbx932013110220pm_b4bfcdba.data?se=2013-09-04T21%3A19%3A45Z&amp;sr=b&amp;sp=r&amp;sig=U31IOEwu2%2Bc69oc%2BFv2pXTec29zspUWYqZKLRtf3MBo%3D</SharedAccessSignatureUri>
	<StorageType>1</StorageType>
	<StorageUri>https://storagedomain.blob.core.windows.net/</StorageUri>
</RESTBlobReadData>

Request

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

Stream BlobStream = RESTClient.ReadEntityContainerBlob("email@email.com", LockBoxEntityIDType.EmailAddress, "password", 100777, "lbx932013110220pm_b4bfcdba");

Request

curl -d "Entity=email@email.com&EntityPassword=passsword&EntityType=0&ContainerID=100777&BlobIDName=lbx932013110220pm_b4bfcdba" https://api.goironcloud.com/latest/ReadEntityContainerBlob

RemoveEntityContainerBlob

Removes a blob from an entity container, returns true on success false otherwise.

POST	https://api.goironcloud.com/{version}/RemoveEntityContainerBlob

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerID	A 64-bit integer container ID
BlobIDName	A string that denotes the blob ID

EXAMPLES

Response

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

Request

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

if (RESTClient.RemoveEntityContainerBlob("email@email.com", LockBoxEntityIDType.EmailAddress, "Password",  12345, "IDofBlobToRemove"))
 {
     // Remove was successful
}

Request

curl -d "Entity=email@email.com&EntityPassword=password&EntityType=0&ContainerID=100777&BlobIDName=lbx932013110220pm_b4bfcdba" https://api.goironcloud.com/latest/RemoveEntityContainerBlob

CreateEntityContainerBlob

Used to create a blob entry within an IronBox container and returns a unique blob ID that the caller can reference.

POST	https://api.goironcloud.com/{version}/CreateEntityContainerBlob

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerID	A 64-bit integer container ID
BlobName	Name of the blob to create (i.e. test.txt).

EXAMPLES

Response

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">lbx1111201385350am_93650331</string>

Request

curl -d "Entity=email@email.com&EntityPassword=password&EntityType=0&ContainerID=100777&BlobName=blob_name" https://api.goironcloud.com/latest/CreateEntityContainerBlob

CheckOutEntityContainerBlob

This method checks out an existing blob. The request locks the blob and returns a set of data for the caller to use. One important piece of data is the CheckInToken which is required when the caller checks back in the blob, which tells IronBox that the caller wishes to move the blob back into its ready state. The other important piece of data is the ShareAccessSignatureUri which is used with an HTTP PUT request to upload the encrypt contents of the blob.

POST	https://api.goironcloud.com/{version}/CheckOutEntityContainerBlob

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerID	A 64-bit integer container ID
BlobIDName	A string that denotes the blob ID

EXAMPLES

Response

<RESTBlobCheckOutData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LockBox">
	<CheckInToken>02357d5e83464399a14fb306635102a1</CheckInToken>
	<ContainerStorageName>lbxe9155a5e68ea4b14ae79096008e9cfca</ContainerStorageName>
	<SharedAccessSignature>?se=2013-11-11T09%3A50%3A04Z&amp;sr=b&amp;sp=w&amp;sig=2p68PQ79tr%2FXt5OAcMKp7D5R94HGDYHuurztUjR2kCE%3D</SharedAccessSignature>
	<SharedAccessSignatureUri>https://icstoragewestprod1.blob.core.windows.net/lbxe9155a5e68ea4b14ae79096008e9cfca/lbx1111201385350am_93650331.data?se=2013-11-11T09%3A50%3A04Z&amp;sr=b&amp;sp=w&amp;sig=2p68PQ79tr%2FXt5OAcMKp7D5R94HGDYHuurztUjR2kCE%3D</SharedAccessSignatureUri>
	<StorageType>1</StorageType>
	<StorageUri>https://icstoragewestprod1.blob.core.windows.net/</StorageUri>
</RESTBlobCheckOutData>

Request

curl -d "Entity=email@email.com&EntityPassword=password&EntityType=0&ContainerID=100777&BlobIDName=lbx1111201385350am_93650331" https://api.goironcloud.com/latest/CheckOutEntityContainerBlob

CheckInEntityContainerBlob

This method checks-in a checked-out blob indicating to IronBox that this blob is ready. This method should only be called after the caller has finished modifying the checked-out blob.

POST	https://api.goironcloud.com/{version}/CheckInEntityContainerBlob

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerID	A 64-bit integer container ID
BlobIDName	A string that denotes the blob ID
BlobSizeBytes	The size of the blob being checked-in in bytes.
BlobCheckInToken	The token provided from the call to CheckOutEntityContainerBlob that authorizes the caller to check the blob back in and mark it in a ready state.

EXAMPLES

Response

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

Request

curl -d "Entity=email@email.com&EntityPassword=password&EntityType=0&ContainerID=100777&BlobIDName=lbx1111201385350am_93650331&BlobCheckInToken=02357d5e83464399a14fb306635102a1&BlobSizeBytes=12345" https://api.goironcloud.com/latest/CheckInEntityContainerBlob

GetContextSetting

Returns the value of a specified setting for a given context. The requesting entity must be a member of the context in order to make this call.

POST	https://api.goironcloud.com/{version}/GetContextSetting

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
Context	Context (e.g. secure.goironcloud.com or demo.goironcloud.com).
ContextSetting	The context setting value to return. Current valid values are "CompanyName" and "CompanyLogoUrl".

EXAMPLES

Response

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">IronBox Online</string>

Request

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

String Value = RESTClient.GetContextSetting("email@email.com", LockBoxEntityIDType.EmailAddress, "Password",  "secure.goironcloud.com","CompanyName");

Request

curl -d "Entity=email@email.com&EntityPassword=password&EntityType=0&Context=secure.goironcloud.com&ContextSetting=CompanyName" https://api.goironcloud.com/latest/GetContextSetting

CreateEntitySFTContainer

Method for creating an IronBox secure file transfer (SFT) container. Duplicate container names are supported. Returns an IronBoxSFTContainerConfig object on success, null otherwise.

POST	https://api.goironcloud.com/{version}/CreateEntitySFTContainer

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
Context	Context (e.g. secure.goironcloud.com or demo.goironcloud.com).
Name	Name of the IronBox SFT container to create (required). Duplicate names are allowed.
Description	Description of the container to create (optional).

EXAMPLES

Response

<RESTSFTContainerConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LockBox">
	<ContainerID>113667</ContainerID>
	<Description>description</Description>
	<FriendlyID>29EB879C83D940D3</FriendlyID>
	<Name>container_name</Name>
</RESTSFTContainerConfig>

Request

using LockBox;
...
RESTSFTContainerConfig InitialConfig = new RESTSFTContainerConfig();
InitialConfig.Name = "Name of new container";
InitialConfig.Description = "Description of container (optional)";
String Context = "secure.goironcloud.com";
RESTSFTContainerConfig Result = RESTClient.CreateEntitySFTContainer("email@email.com", LockBoxEntityIDType.EmailAddress, "Password", Context, InitialConfig);
if (Result != null)
{
     // Container successfully created
}

Request

curl -d "Entity=email@email.com&EntityPassword=password&EntityType=0&Context=secure.goironcloud.com&Name=container_name&Description=description" https://api.goironcloud.com/latest/CreateEntitySFTContainer

RemoveEntityContainer

Removes an IronBox entity container. Caller must be the owner of the container being removed. Returns true on success, false otherwise.

POST	https://api.goironcloud.com/{version}/RemoveEntityContainer

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerID	A 64-bit integer container ID

EXAMPLES

Response

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

Request

LockBoxRESTClient RESTClient = new LockBoxRESTClient(IronBox_APIServerURL);
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

if (RESTClient.RemoveEntityContainer("email@email.com", LockBoxEntityIDType.EmailAddress, "Password", 1234567))
{
     // Remove successful
}

Request

curl -d "Entity=email@email.com&EntityPassword=password&EntityType=0&ContainerID=1234567" https://api.goironcloud.com/latest/RemoveEntityContainer

SetEntityContainerEasyAccess

Enable Easy Access on an existing container. Returns a list of the Easy Access URL(s) with which external users (i.e. users that do not have an IronBox account) can access the container.

POST	https://api.goironcloud.com/{version}/SetEntityContainerEasyAccess

{version} refers to the version of the API to call. Available values are v2 and latest.

QUERY PARAMETERS

Parameter	Description
Entity	Entity user name, such as an email or entity ID.
EntityType	An integer indicating the entity type (0 = email address, 1 = name identifier, 2 = entity ID)
EntityPassword	Entity password
ContainerID	A 64-bit integer container ID
EasyAccessMode	An integer indicating the Easy Access mode to use (0 = receive only, 1 = send only and 2 = receive and send)
EasyAccessPassword	Password to access the resulting Easy Access link, optional for Easy Access mode 0, but required for 1 and 2

EXAMPLES

Response

<RESTContainerEasyAccessData>
    <EasyAccessUrls>
        <d2p1:string>https://secure.goironcloud.com/Containers/Container.aspx?fid=852B873F815B499D</d2p1:string>
    </EasyAccessUrls>
</RESTContainerEasyAccessData>

Request

using LockBox;
...
LockBoxRESTClient RESTClient = new LockBoxRESTClient("https://api.goironcloud.com");
RESTClient.APIVersion = LockBoxAPIVersion.Latest;

RESTEasyAccessData EasyAccessData = RESTClient.SetEntityContainerEasyAccess("email@email.com", LockBoxEntityIDType.EmailAddress, "password", 100777, RESTEasyAccessMode.ReceiveOnly,"MyEasyAccessPassword");

Request

curl -d "Entity=email@email.com&EntityPassword=password&EntityType=0&ContainerID=100777&EasyAccessMode=0&EasyAccessPassword=hello" https://api.goironcloud.com/latest/SetEntityContainerEasyAccess