Shared Drives

Generated on 18 Mar 2026

Base URL https://api.paperspace.com/v1

Endpoints

GET List shared drives POST Create a shared drive GET Get a shared drive PUT Update a shared drive DELETE Delete a shared drive

GET List shared drives

/shared-drives
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of shared drives.

Query Parameters

after string optional

Fetch the next page of results after this cursor.

limit integer 1 – 120 optional

The number of items to fetch after this page.

orderBy string, one of: dtCreated, name optional

Order results by one of these fields.

Default: dtCreated
order string, one of: asc, desc optional

The order to sort the results by.

Default: desc
name string optional
region string optional
Request: /shared-drives
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/shared-drives"

Responses

200

Successful response
Response Schema: application/json
hasMore boolean required

Whether there are more pages of results available.

items array of object required

The items on this page.

Show child properties
dtCreated string (date-time) required

The date the shared drive was created.

dtDeleted string optional Nullable

The date the shared drive was deleted.

id string required

The ID of the shared drive.

mountPoint string required

The mount point of the shared drive.

name string required

The name of the shared drive.

networkId string required

The ID of the network the shared drive is in.

password string required

The password of the shared drive.

region string, one of: ny2, ca1, ams1 required

The region the shared drive is in.

size integer (int64) required

The size of the shared drive.

username string required

The username of the shared drive.

nextPage string optional

The cursor required to fetch the next page of results. i.e. ?after=nextPage. This is null when there is no next page.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "hasMore": true,
  "items": [
    {
      "dtCreated": "2019-08-24T14:15:22Z",
      "id": "string",
      "mountPoint": "string",
      "name": "string",
      "networkId": "string",
      "password": "string",
      "region": "ny2",
      "size": 0,
      "username": "string"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Create a shared drive

/shared-drives
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Creates a new shared drive for use in a private network.

Request Body: application/json

name string required

The name of the shared drive.

networkId string required

The ID of the network the shared drive is in.

region string required

The region the shared drive is in.

size number (enum, 10 values) required

The size of the shared drive in gigabytes.

Request: /shared-drives
Content type application/json 
{
  "name": "string",
  "networkId": "string",
  "region": "string",
  "size": 0
}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "networkId": "string",
  "region": "string",
  "size": 0
}' \
  "https://api.paperspace.com/v1/shared-drives"

Responses

200

Successful response
Response Schema: application/json
dtCreated string (date-time) required

The date the shared drive was created.

dtDeleted string optional Nullable

The date the shared drive was deleted.

id string required

The ID of the shared drive.

mountPoint string required

The mount point of the shared drive.

name string required

The name of the shared drive.

networkId string required

The ID of the network the shared drive is in.

password string required

The password of the shared drive.

region string, one of: ny2, ca1, ams1 required

The region the shared drive is in.

size integer (int64) required

The size of the shared drive.

username string required

The username of the shared drive.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "id": "string",
  "mountPoint": "string",
  "name": "string",
  "networkId": "string",
  "password": "string",
  "region": "ny2",
  "size": 0,
  "username": "string"
}
{
  "code": "string",
  "message": "string"
}

GET Get a shared drive

/shared-drives/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a single shared drive by ID.

Path Parameters

id string required

The ID of the shared drive to fetch.

Request: /shared-drives/{id}
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/shared-drives/{id}"

Responses

200

Successful response
Response Schema: application/json
dtCreated string (date-time) required

The date the shared drive was created.

dtDeleted string optional Nullable

The date the shared drive was deleted.

id string required

The ID of the shared drive.

mountPoint string required

The mount point of the shared drive.

name string required

The name of the shared drive.

networkId string required

The ID of the network the shared drive is in.

password string required

The password of the shared drive.

region string, one of: ny2, ca1, ams1 required

The region the shared drive is in.

size integer (int64) required

The size of the shared drive.

username string required

The username of the shared drive.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "id": "string",
  "mountPoint": "string",
  "name": "string",
  "networkId": "string",
  "password": "string",
  "region": "ny2",
  "size": 0,
  "username": "string"
}
{
  "code": "string",
  "message": "string"
}

PUT Update a shared drive

/shared-drives/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Updates a single shared drive by ID.

Path Parameters

id string required

The ID of the shared drive to fetch.

Request Body: application/json

name string optional

The name of the shared drive.

Request: /shared-drives/{id}
Content type application/json 
{
  "name": "string"
}
curl -X PUT \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}' \
  "https://api.paperspace.com/v1/shared-drives/{id}"

Responses

200

Successful response
Response Schema: application/json
dtCreated string (date-time) required

The date the shared drive was created.

dtDeleted string optional Nullable

The date the shared drive was deleted.

id string required

The ID of the shared drive.

mountPoint string required

The mount point of the shared drive.

name string required

The name of the shared drive.

networkId string required

The ID of the network the shared drive is in.

password string required

The password of the shared drive.

region string, one of: ny2, ca1, ams1 required

The region the shared drive is in.

size integer (int64) required

The size of the shared drive.

username string required

The username of the shared drive.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "id": "string",
  "mountPoint": "string",
  "name": "string",
  "networkId": "string",
  "password": "string",
  "region": "ny2",
  "size": 0,
  "username": "string"
}
{
  "code": "string",
  "message": "string"
}

DELETE Delete a shared drive

/shared-drives/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Deletes a single shared drive by ID.

Path Parameters

id string required

The ID of the shared drive to delete.

Request: /shared-drives/{id}
curl -X DELETE \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/shared-drives/{id}"

Responses

200

Successful response
Response Schema: application/json
id string required

The ID of the deleted shared drive.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "id": "string"
}
{
  "code": "string",
  "message": "string"
}

We can't find any results for your search.

Try using different keywords or simplifying your search terms.