Skip to content

Commit cd12d01

Browse files
colin-welchgitbook-bot
colin-welch
authored and
gitbook-bot
committed
GitBook: [master] one page modified
1 parent 190cc76 commit cd12d01

File tree

1 file changed

+43
-27
lines changed

1 file changed

+43
-27
lines changed

‎api-documentation/machines/create.md‎

Lines changed: 43 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ paperspace.machines.create({
6464
<td style="text-align:left">string</td>
6565
<td style="text-align:left"></td>
6666
<td style="text-align:left">Name of the region: either &apos;East Coast (NY2)&apos;, &apos;West Coast
67-
(CA1)&apos;, or &apos;Europe (AMS1)&apos;</td>
67+
(CA1)&apos;, or &apos;Europe (AMS1)&apos;.</td>
6868
</tr>
6969
<tr>
7070
<td style="text-align:left"><code>machineType</code>
@@ -89,28 +89,28 @@ paperspace.machines.create({
8989
</td>
9090
<td style="text-align:left">number</td>
9191
<td style="text-align:left"></td>
92-
<td style="text-align:left">Storage size for the machine in GB</td>
92+
<td style="text-align:left">Storage size for the machine in GB.</td>
9393
</tr>
9494
<tr>
9595
<td style="text-align:left"><code>billingType</code>
9696
</td>
9797
<td style="text-align:left">string</td>
9898
<td style="text-align:left"></td>
99-
<td style="text-align:left">Either &apos;monthly&apos; or &apos;hourly&apos; billing</td>
99+
<td style="text-align:left">Either &apos;monthly&apos; or &apos;hourly&apos; billing.</td>
100100
</tr>
101101
<tr>
102102
<td style="text-align:left"><code>machineName</code>
103103
</td>
104104
<td style="text-align:left">string</td>
105105
<td style="text-align:left"></td>
106-
<td style="text-align:left">A memorable name for this machine</td>
106+
<td style="text-align:left">A memorable name for this machine.</td>
107107
</tr>
108108
<tr>
109109
<td style="text-align:left"><code>templateId</code>
110110
</td>
111111
<td style="text-align:left">string</td>
112112
<td style="text-align:left"></td>
113-
<td style="text-align:left">Template id of the template to use for creating this machine</td>
113+
<td style="text-align:left">Template ID of the template to use for creating this machine.</td>
114114
</tr>
115115
<tr>
116116
<td style="text-align:left"><code>assignPublicIp</code>
@@ -119,8 +119,7 @@ paperspace.machines.create({
119119
<td style="text-align:left">&lt;optional&gt;
120120
<br />
121121
</td>
122-
<td style="text-align:left">Assign a new public ip address on machine creation. Cannot be used with
123-
dynamicPublicIp.</td>
122+
<td style="text-align:left">Assign a new public ip address on machine creation. Cannot be used with <code>dynamicPublicIp</code>.</td>
124123
</tr>
125124
<tr>
126125
<td style="text-align:left"><code>dynamicPublicIp</code>
@@ -129,8 +128,15 @@ paperspace.machines.create({
129128
<td style="text-align:left">&lt;optional&gt;
130129
<br />
131130
</td>
132-
<td style="text-align:left">Assigns a new public ip address on machine start and releases it from
133-
the account on machine stop. Cannot be used with assignPublicIp.</td>
131+
<td style="text-align:left">Assigns a new public IP address on machine start and releases it from
132+
the account on machine stop. Cannot be used with <code>assignPublicIp</code>.</td>
133+
</tr>
134+
<tr>
135+
<td style="text-align:left"><code>startOnCreate</code>
136+
</td>
137+
<td style="text-align:left">boolean</td>
138+
<td style="text-align:left">&lt;optional&gt;</td>
139+
<td style="text-align:left">Start the VM immediately after creation. Defaults to <code>true</code>.</td>
134140
</tr>
135141
<tr>
136142
<td style="text-align:left"><code>networkId</code>
@@ -139,16 +145,17 @@ paperspace.machines.create({
139145
<td style="text-align:left">&lt;optional&gt;
140146
<br />
141147
</td>
142-
<td style="text-align:left">If creating on a specific network, specify its id</td>
148+
<td style="text-align:left">If creating on a specific network, specify its ID</td>
143149
</tr>
144150
<tr>
145-
<td style="text-align:left"><code>teamId</code>
151+
<td style="text-align:left"><code>scriptId</code>
146152
</td>
147153
<td style="text-align:left">string</td>
148154
<td style="text-align:left">&lt;optional&gt;
149155
<br />
150156
</td>
151-
<td style="text-align:left">If creating the machine for a team, specify the team id</td>
157+
<td style="text-align:left">The script ID of a script to be run on startup. See the <a href="https://paperspace.github.io/paperspace-node/scripts.md">Script Guide</a> for
158+
more info on using scripts.</td>
152159
</tr>
153160
<tr>
154161
<td style="text-align:left"><code>userId</code>
@@ -158,7 +165,7 @@ paperspace.machines.create({
158165
<br />
159166
</td>
160167
<td style="text-align:left">If assigning to an existing user other than yourself, specify the user
161-
id (mutually exclusive with email, password, firstName, lastName)</td>
168+
ID (mutually exclusive with <code>email</code>, <code>password</code>, <code>firstName</code>, <code>lastName</code>).</td>
162169
</tr>
163170
<tr>
164171
<td style="text-align:left"><code>email</code>
@@ -168,7 +175,7 @@ paperspace.machines.create({
168175
<br />
169176
</td>
170177
<td style="text-align:left">If creating a new user for this machine, specify their email address (mutually
171-
exclusive with userId)</td>
178+
exclusive with <code>userId</code>).</td>
172179
</tr>
173180
<tr>
174181
<td style="text-align:left"><code>password</code>
@@ -177,8 +184,7 @@ paperspace.machines.create({
177184
<td style="text-align:left">&lt;optional&gt;
178185
<br />
179186
</td>
180-
<td style="text-align:left">If creating a new user, specify their password (mutually exclusive with
181-
userId)</td>
187+
<td style="text-align:left">If creating a new user, specify their password (mutually exclusive with <code>userId</code>).</td>
182188
</tr>
183189
<tr>
184190
<td style="text-align:left"><code>firstName</code>
@@ -187,8 +193,7 @@ paperspace.machines.create({
187193
<td style="text-align:left">&lt;optional&gt;
188194
<br />
189195
</td>
190-
<td style="text-align:left">If creating a new user, specify their first name (mutually exclusive with
191-
userId)</td>
196+
<td style="text-align:left">If creating a new user, specify their first name (mutually exclusive with <code>userId</code>).</td>
192197
</tr>
193198
<tr>
194199
<td style="text-align:left"><code>lastName</code>
@@ -197,8 +202,7 @@ paperspace.machines.create({
197202
<td style="text-align:left">&lt;optional&gt;
198203
<br />
199204
</td>
200-
<td style="text-align:left">If creating a new user, specify their last name (mutually exclusive with
201-
userId)</td>
205+
<td style="text-align:left">If creating a new user, specify their last name (mutually exclusive with <code>userId</code>).</td>
202206
</tr>
203207
<tr>
204208
<td style="text-align:left"><code>notificationEmail</code>
@@ -207,17 +211,29 @@ paperspace.machines.create({
207211
<td style="text-align:left">&lt;optional&gt;
208212
<br />
209213
</td>
210-
<td style="text-align:left">Send a notification to this email address when complete</td>
214+
<td style="text-align:left">Send a notification to this email address when complete.</td>
211215
</tr>
212216
<tr>
213-
<td style="text-align:left"><code>scriptId</code>
217+
<td style="text-align:left"><code>takeInitialSnapshot</code>
214218
</td>
215-
<td style="text-align:left">string</td>
216-
<td style="text-align:left">&lt;optional&gt;
217-
<br />
219+
<td style="text-align:left">boolean</td>
220+
<td style="text-align:left">&lt;optional&gt;</td>
221+
<td style="text-align:left">Take a snapshot of the VM at first boot.</td>
222+
</tr>
223+
<tr>
224+
<td style="text-align:left"><code>markSnapshotAsRestorePoint</code>
218225
</td>
219-
<td style="text-align:left">The script id of a script to be run on startup. See the <a href="https://paperspace.github.io/paperspace-node/scripts.md">Script Guide</a> for
220-
more info on using scripts.</td>
226+
<td style="text-align:left">boolean</td>
227+
<td style="text-align:left">&lt;optional&gt;</td>
228+
<td style="text-align:left">Use initial snapshot as a restore point for the VM. If this is true, <code>takeInitialSnapshot</code> must
229+
be true and <code>restorePointFrequency</code> must be specified.</td>
230+
</tr>
231+
<tr>
232+
<td style="text-align:left"><code>restorePointFrequency</code>
233+
</td>
234+
<td style="text-align:left">string</td>
235+
<td style="text-align:left">&lt;optional&gt;</td>
236+
<td style="text-align:left">How often the VM&apos;s restore point should be used. Valid options: <code>shutdown</code>.</td>
221237
</tr>
222238
</tbody>
223239
</table>

0 commit comments

Comments
 (0)