CloudDeploy

✖
`CloudDeploy`

✖

CloudDeploy[expr]

deploys expr to a new anonymous cloud object.

✖

CloudDeploy[expr,location]

deploys expr to a cloud object at the specified location relative to the user's current cloud directory.

✖

CloudDeploy[expr,CloudObject[…]]

deploys expr to the specified cloud object.

Details and Options

CloudDeploy works from both desktop and cloud.
CloudDeploy returns the CloudObject that was deployed.
CloudDeploy performs different actions depending on the form of expr:

	APIFunction[…]	create a web API to access using GET or POST requests
	FormFunction[…]	create a form to access from the web
	FormPage[…]	create a page containing a form and result to access from the web
	AskFunction[…]	deploy a program that asks questions during execution
	NotebookObject[…]	output as a notebook in the cloud
	ExportForm[expr,"fmt"]	output expr in the specified format
	Delayed[obj]	set obj to be reevaluated whenever it is accessed on the web
	Dynamic[obj]	set obj to be dynamically autorefreshed on the web
	ScheduledTask[expr,…]	evaluate expr on a schedule
	ContinuousTask[expr]	continuously reevaluate expr
	AutoRefreshed[obj,…]	set obj to be reevaluated on a schedule
	HTTPResponse[…]	give a specific HTTP response on the web
	HTTPRedirect[…]	redirect to another location on the web
	ExternalBundle[…]	deploy a directory or hierarchy of objects
	EmbedCode[…]	output as a web version of embed code
	GrammarRules[…]	deploy as a grammar to be applied
	URLDispatcher[…]	define a dispatcher of relative URLs
	MailReceiverFunction[…]	deploy a mail receiver
	ChannelReceiverFunction[…]	deploy a channel receiver

For other forms of expr, CloudDeploy[expr,…] gives a cloud notebook, equivalent to CloudDeploy[ExportForm[expr,"NB"],…].
CloudDeploy[expr,URL["loc"]] is equivalent to CloudDeploy[expr,"loc"].
CloudDeploy[Dynamic[obj,UpdateInterval->dt]] specifies that the web output should be refreshed every dt seconds.
CloudDeploy allows the following options:

AutoCopy	False	whether to make a copy when opened
AutoRemove	False	whether to schedule the object for deletion
CachePersistence	Automatic	controls the time duration for which an object is cached by a client
CloudBase	Automatic	what cloud to deploy to
CloudObjectNameFormat	Automatic	format to use for the name portion of the URL
CloudObjectURLType	Automatic	base type of URL to use (obj, env, ...)
EvaluationPrivileges	Automatic	privileges of evaluations by the object
IconRules	Automatic	icons to use for the deployed object
IncludeDefinitions	True	whether to automatically include dependencies
Magnification	Automatic	magnification to use for the deployed notebook
MetaInformation	{}	metainformation for the deployed object
Permissions	Automatic	permissions for the deployed object
SourceLink	Automatic	object to be linked as the source

With IncludeDefinitions->True, CloudDeploy[expr,…] automatically deploys all definitions needed to evaluate expr. With IncludeDefinitions->False, the evaluation of expr must explicitly evaluate all definitions that are needed.
With the default setting MagnificationAutomatic, CloudDeploy ignores any Magnification setting in the source document and uses a 100% magnification in the deployed notebook. With MagnificationInherited, the magnification of the source document is preserved.
With the default setting Permissions->Automatic, CloudDeploy creates a cloud object with permissions set to $Permissions, which is usually private.
With the default setting SourceLink->Automatic, CloudDeploy sets the source link for the deployed cloud object to be the cloud object corresponding to the current notebook. If no such cloud object exists, it sets the source link to None.
To copy an existing local file to the cloud, use CopyFile.

Examples

open allclose all

Basic Examples (3)Summary of the most common use cases

Deploy a Manipulate expression to a new anonymous cloud object:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-8qkmfu

Out[1]=1

Deploy an APIFunction to a new unnamed object:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-potdve

Out[1]=1

The resulting API viewed in a web browser, with color set to Blue:

Deploy a FormFunction to a named object:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-bj4oo1

Out[1]=1

Scope (6)Survey of the scope of standard use cases

APIFunction (1)

Deploy a web API:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-sdmdg

Out[1]=1

FormFunction (1)

Deploy a form:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-mu9bq9

Out[1]=1

Notebook (1)

Deploy a notebook:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-1ge9p6

Out[1]=1

ExportForm (1)

Deploy an expression in a specified export format such as "PNG":

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-qrvoyr

Out[1]=1

Manipulate (1)

Deploy an interactive Manipulate:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-8xgwnb

Out[1]=1

Delayed (1)

Deploy an expression to be reevaluated whenever it is accessed on the web:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-dhodi7

Out[1]=1

Options (4)Common values & functionality for each option

AutoRemove (1)

Deploy a form function to a temporary object:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-f3tcu5

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/05fd5yprh6-vg4os0

Out[2]=2

Magnification (1)

Deployed notebook uses a 100% magnification by default:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-w7a568

Out[1]=1

Preserve the magnification of the source document:

In[2]:=2

✖

https://wolfram.com/xid/05fd5yprh6-n809x

Out[2]=2

Permissions (1)

Deploy a cloud object with public permissions:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-vvywe7

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/05fd5yprh6-gvpbem

Out[2]=2

SourceLink (1)

Deploy with a cloud notebook given as the source:

In[1]:=1

✖

https://wolfram.com/xid/05fd5yprh6-binsnt

Out[1]=1

View the source link:

In[2]:=2

✖

https://wolfram.com/xid/05fd5yprh6-f98bpo

Out[2]=2

Make a copy of the original source to preserve the source as it was at the time of deployment:

In[3]:=3

✖

https://wolfram.com/xid/05fd5yprh6-g35wtc

Out[3]=3

Deploy without a source link:

In[4]:=4

✖

https://wolfram.com/xid/05fd5yprh6-b5qx9h

Out[4]=4

Confirm that there is no source link:

In[5]:=5

✖

https://wolfram.com/xid/05fd5yprh6-knj7jj

Out[5]=5

Properties & Relations (3)Properties of the function, and connections to other functions

Saving Dependencies (1)

All dependencies of the deployed expression are persisted in the resulting cloud object, by effectively executing CloudPut with IncludeDefinitions set to True:

In[1]:=1