This repository has been archived by the owner on Jun 6, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
document assignPublicIp param on machines create method
- Loading branch information
Showing
1 changed file
with
5 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,7 @@ var assign = require('lodash.assign'); | |
| * @param {string} params.billingType - Either 'monthly' or 'hourly' billing | ||
| * @param {string} params.machineName - A memorable name for this machine | ||
| * @param {string} params.templateId - Template id of the template to use for creating this machine | ||
| * @param {boolean} [params.assignPublicIp] - Assign a new public ip address on machine creation | ||
| * @param {string} [params.networkId] - If creating on a specific network, specify its id | ||
| * @param {string} [params.teamId] - If creating the machine for a team, specify the team id | ||
| * @param {string} [params.userId] - If assigning to an existing user other than yourself, specify the user id | ||
|
|
@@ -41,6 +42,7 @@ var assign = require('lodash.assign'); | |
| * billingType: 'hourly', | ||
| * machineName: 'My Machine 1', | ||
| * templateId: 't123abc', | ||
| * assignPublicIp: true, // optional - assign a new public ip address | ||
| * networkId: 'n123abc', // optional - only if creating on a specific network | ||
| * teamId: 'te456def', // optional - required if creating this machine for a team | ||
| * userId: 'u123abc', // optional - required if assigning to an existing user other than yourself | ||
|
|
@@ -61,6 +63,7 @@ var assign = require('lodash.assign'); | |
| * --billingType "hourly" \ | ||
| * --machineName "My Machine 1" \ | ||
| * --templateId "t123abc" \ | ||
| * --assignPublicIp true \ | ||
| * --networkId "n123abc" \ | ||
| * --teamId "te456def" \ | ||
| * --userId "u123abc" \ | ||
|
|
@@ -73,7 +76,7 @@ var assign = require('lodash.assign'); | |
| * @example | ||
| * # HTTP request: | ||
| * https://api.paperspace.io | ||
| * POST /machines/createSingleMachinePublic {"region": "East Coast (NY2)", "machineType": "Air", "size": 50, "billingType": "monthly", "machineName": "My Machine 1", "templateId": "t123abc", "networkId": "n123abc", "teamId": "te456def", "userId": "u123abc", "email": "example@example.com", "password": "secret123", "firstName": "Jon", "lastName": "Snow", "notificationEmail": "[email protected]"} | ||
| * POST /machines/createSingleMachinePublic {"region": "East Coast (NY2)", "machineType": "Air", "size": 50, "billingType": "monthly", "machineName": "My Machine 1", "templateId": "t123abc", "assignPublicIp": true, "networkId": "n123abc", "teamId": "te456def", "userId": "u123abc", "email": "example@example.com", "password": "secret123", "firstName": "Jon", "lastName": "Snow", "notificationEmail": "[email protected]"} | ||
| * x-api-key: 1ba4f98e7c0... | ||
| * # Returns 201 on success | ||
| * @example | ||
|
|
@@ -98,7 +101,7 @@ var assign = require('lodash.assign'); | |
| * "state": "provisioning", | ||
| * "networkId": null, | ||
| * "privateIpAddress": null, | ||
| * "publicIpAddress": null, | ||
| * "publicIpAddress": "169.255.255.254", | ||
| * "region": null, | ||
| * "userId": "u123abc", | ||
| * "teamId": "te456def" | ||
|
|
||