GitBook: [master] 27 pages and 3 assets modified

Author: Daniel Kobran

.gitbook/assets/image.png

@@ -0,0 +1,52 @@
+# Introduction
+
+![](.gitbook/assets/paperspace-core-api2.jpg)
+
+Welcome to the **Paperspace CORE API** documentation. CORE provides a RESTful API for programmatically managing your compute resources. It is currently available through the use of standard HTTP requests as well as a JavaScript client for Node.js. We plan to offer other languages and integrations in the future. 
+
+## Usage <a id="usage"></a>
+
+You can interact with CORE API in two ways: by using an HTTP client of your choice and the Paperspace API HTTP endpoints or programmatically from within a Javascript Node.js application.
+
+## Other clients <a id="other-clients"></a>
+
+If you've created an API client in a language other than JavaScript, please let us know at [support@paperspace.com](mailto:support@paperspace.com) and we will link to it here.
+
+## Sample Apps <a id="sample-apps"></a>
+
+See the directory [samples](https://github.com/Paperspace/paperspace-node/tree/master/samples) for a few simple samples of using the node API, and the CLI in a bash script. Note: the [jq](https://stedolan.github.io/jq/) tool is used in the bash sample for parsing JSON data.
+
+## Contributing <a id="contributing"></a>
+
+We welcome contributions to this project. Please adhere to the established coding conventions within the project and submit changes using pull requests.
+
+Additional information for developers is here: [developers.md](https://paperspace.github.io/paperspace-node/developers.md)
+
+## Bugs / Support / Troubleshooting <a id="bugs-%2F-support-%2F-troubleshooting"></a>
+
+For bugs with the API client or the HTTP API, please file tickets using GitHub Issues on [this](https://github.com/paperspace/paperspace-node) repo. We'll do our best to respond as quickly as we can. Keep in mind that Paperspace is a small team and you may need to allow up to a week for a response.
+
+Other issues, such as those related to your Paperspace account, your team or team members, billing, or technical issues with your Paperspace machines should be directed to [support@paperspace.com](mailto:support@paperspace.com).
+
+## Security <a id="security"></a>
+
+Think you've discovered a security flaw or exploit? Please contact us directly at [support@paperspace.com](mailto:support@paperspace.com) and we will respond as quickly as we can.
+
+## Disclaimer <a id="disclaimer"></a>
+
+**Use the CORE API with care.** This tool is provided as-is \(please see our [LICENSE](./#license)\). Know that many actions provided via our public API can result in billing charges for Paperspace services. Please be aware of Paperspace's billing policies before performing any of these actions; you'll see charges reflected in your invoice at the end of the month. Some actions, such as deactivating machines, are irreversible, resulting in permanent loss of data. Paperspace cannot recover lost data such as mistakenly deleted account information, and may only be able to give limited assistance if an action is performed mistakenly. API access will be disabled for accounts not in good standing. Keeping your account credentials secret is your responsibility. You may only use Paperspace's CORE API to store, retrieve, query, serve, and execute content that is owned, licensed or lawfully obtained by you.
+
+## License <a id="license"></a>
+
+This project is open-source, under the ISC license. 
+
+> Copyright \(c\) 2017, Paperspace support@paperspace.com&gt;
+>
+> Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+>
+> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+## Copyright <a id="copyright"></a>
+
+Copyright 2021 Paperspace Co. - All Rights Reserved
+

.gitbook/assets/paperspace-core-api.jpg

@@ -0,0 +1,40 @@
+# Table of contents
+
+* [Introduction](README.md)
+
+## Get Started
+
+* [Obtaining an API Key](get-started/obtaining-an-api-key.md)
+* [Quickstart](get-started/quickstart.md)
+* [Node.js client](get-started/node.js-client-installation.md)
+
+## API documentation
+
+* [Machines](api-documentation/machines-1/README.md)
+  * [Create](api-documentation/machines-1/create.md)
+  * [Start](api-documentation/machines-1/start.md)
+  * [Stop](api-documentation/machines-1/stop.md)
+  * [Restart](api-documentation/machines-1/restart.md)
+  * [Destroy](api-documentation/machines-1/destroy.md)
+  * [Update](api-documentation/machines-1/update.md)
+  * [List](api-documentation/machines-1/list.md)
+  * [Show](api-documentation/machines-1/show.md)
+  * [Set access for user](api-documentation/machines-1/set-access-for-user.md)
+  * [Utilization](api-documentation/machines-1/utilization.md)
+  * [Wait for](api-documentation/machines-1/wait-for.md)
+  * [Availability](api-documentation/machines-1/machines.md)
+* [Templates](api-documentation/templates/README.md)
+  * [List](api-documentation/templates/list.md)
+* [Networks](api-documentation/networks/README.md)
+  * [List](api-documentation/networks/list.md)
+* [Users](api-documentation/users-2/README.md)
+  * [List](api-documentation/users-2/list.md)
+  * [logout](api-documentation/users-2/logout.md)
+
+---
+
+* [Resource Delegations](resourcedelegations.md)
+* [Scripts](scripts.md)
+
+## Users <a id="users-1"></a>
+

.gitbook/assets/paperspace-core-api2.jpg

@@ -0,0 +1,99 @@
+# Machines
+
+CORE machines are Linux and Windows-based virtual machines \(VMs\) that run on top of virtualized hardware.  Each machine you create is a new server or desktop instance you can use, either standalone or as part of a larger, cloud-based infrastructure.
+
+## Regional availability
+
+**US East \(NY2\)**   
+East Coast US, near New York City
+
+**US West \(CA1\)**   
+West Coast US, near San Francisco
+
+**EU \(AMS1\)**   
+Central Europe, near Amsterdam 
+
+You can test latency to Paperspace datacenters by following [this](https://support.paperspace.com/hc/en-us/articles/360006088293) guide.  
+You can view the status of our datacenters [here](http://status.paperspace.com/).
+
+Future expansion: We are in the process of expanding our global coverage.  [Y](https://blog.paperspace.com/)ou can follow [changelog](https://updates.paperspace.com) for updates.
+
+_Please note that if you are more than 2,000 miles from a data center, you may experience some latency._
+
+## Operating systems
+
+### **Windows**
+
+![mceclip0.png](https://support.paperspace.com/hc/article_attachments/360074205033/mceclip0.png)
+
+**Windows 10** \(Server 2019\) - Licensed  
+A fully licensed Windows 10 Experience, provided by Windows Server 2019.   
+Available Machine Types: _Air, Standard, Advanced Pro, GPU+/P4000, P5000, P6000_
+
+**Windows 10** \(Pro\) - BYOL \(Bring Your Own License\)  
+Windows 10 Pro is available as BYOL or Bring Your Own License.  
+Available Machine Types: _Air, Standard, Advanced Pro, GPU+/P4000, P5000, P6000_
+
+### **Linux**
+
+![mceclip1.png](https://support.paperspace.com/hc/article_attachments/360073002774/mceclip1.png)
+
+**Ubuntu 18.04** \(Server\)  
+A Linux VPS in the cloud.  
+Available Machine Types: _GPU+, P4000, P5000, P6000, V100, C1-C10_
+
+### **Public Templates**
+
+![mceclip2.png](https://support.paperspace.com/hc/article_attachments/360074207633/mceclip2.png)
+
+**Parsec**  
+A Windows \(Server\) desktop template perfect for gaming  
+Available Machine Types: _GPU+, P4000, P5000, P6000_
+
+**ML-in-a-Box** \(Desktop\)  
+A Linux desktop with a [suite of Machine Learning software](https://support.paperspace.com/hc/en-us/articles/236406527) packages included, running 18.04.  
+Available Machine Types: _GPU+, P4000, P5000, P6000_
+
+{% hint style="info" %}
+**Note:** All Operating Systems offered by Paperspace are 64-bit
+{% endhint %}
+
+### Networking
+
+* [Dedicated Private Networks](https://support.paperspace.com/hc/en-us/articles/216115938-Dedicated-Private-Networks)
+* [VPN Gateway](https://support.paperspace.com/hc/en-us/articles/216949797-VPN-Gateway)
+* [Public IP Addresses](https://support.paperspace.com/hc/en-us/articles/360051421153-Public-IP-Addresses)
+
+### Add-ons and integrations
+
+* [Team Integrations and Add-Ons Pricing](https://support.paperspace.com/hc/en-us/articles/235665847-Team-Integrations-and-Add-Ons-Pricing)
+* [Active Directory](https://support.paperspace.com/hc/en-us/articles/216604077-Active-Directory)
+* [Shared Drives](https://support.paperspace.com/hc/en-us/articles/216688737-Shared-Drives)
+* [Content Filtering Appliance](https://support.paperspace.com/hc/en-us/articles/115005869888-Content-Filtering-Appliance)
+
+### Bandwidth
+
+There are no bandwidth charges for either ingress or egress. 
+
+### Limits
+
+Paperspace accounts have two types of limits:
+
+#### Service Limits
+
+When you sign up for Paperspace, there are limits to the number of items you can have in your account. 
+
+If you need to increase a Service Limit, please [submit a support ticket](https://support.paperspace.com/hc/en-us/requests/new) and select Service Limits Increase from the drop-down. Please tell us a little about how you're using Paperspace and how many machines you require so we can process your request effectively.
+
+![](https://support.paperspace.com/hc/article_attachments/360001973194/mceclip0.png)
+
+Service Limits are visible under the Account tab.
+
+![](https://support.paperspace.com/hc/article_attachments/360013244014/mceclip0.png)
+
+#### Machine Type Limits
+
+Certain machine types require approval. If you visit the console, you may see machines that are not selectable which means you need additional approval to access them.  You can either place a request in the console or reach out to your account manager.  
+
+
+