Projects

Generated on 18 Mar 2026

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

Endpoints

GET List projects POST Create a project GET Get a project by its ID PUT Update a project DELETE Delete a project GET List a project's activity GET List a project's collaborators POST Create a project collaborator DELETE Delete a project collaborator GET List a project's deployments GET List a project's models POST Add a model to a project DELETE Remove a model from project GET List a project's secrets POST Create a project secret GET Get a project secret PATCH Update a project secret DELETE Delete a project secret GET List a project's tags POST Add a tag to a project DELETE Remove a tag from a project

GET List projects

/projects
Authorizations: BearerAuth
Http: Bearer

An API key or access token

List projects. This endpoint supports pagination and sorting.

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 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
Request: /projects
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/projects"

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 project was created

dtDeleted string (date-time) optional Nullable

The date the project was deleted

id string required

The ID of the project

name string required

The name of the project

repoName string optional Nullable

The name of the GitHub repository if this is is a GitHub-connected project.

repoNodeId string optional Nullable

The node ID of the GitHub repository if this is is a GitHub-connected project.

repoUrl string optional Nullable

The URL of the GitHub repository if this is is a GitHub-connected project.

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",
      "dtDeleted": "2019-08-24T14:15:22Z",
      "id": "string",
      "name": "string",
      "repoName": "string",
      "repoNodeId": "string",
      "repoUrl": "string"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Create a project

/projects
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Create a project

Request Body: application/json

name string required

The name of the project

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

Responses

200

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

The date the project was created

dtDeleted string (date-time) optional Nullable

The date the project was deleted

id string required

The ID of the project

name string required

The name of the project

repoName string optional Nullable

The name of the GitHub repository if this is is a GitHub-connected project.

repoNodeId string optional Nullable

The node ID of the GitHub repository if this is is a GitHub-connected project.

repoUrl string optional Nullable

The URL of the GitHub repository if this is is a GitHub-connected project.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtDeleted": "2019-08-24T14:15:22Z",
  "id": "string",
  "name": "string",
  "repoName": "string",
  "repoNodeId": "string",
  "repoUrl": "string"
}
{
  "code": "string",
  "message": "string"
}

GET Get a project by its ID

/projects/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Get a project by its ID.

Path Parameters

id string required

The ID of the project to get

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

Responses

200

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

The date the project was created

dtDeleted string (date-time) optional Nullable

The date the project was deleted

id string required

The ID of the project

name string required

The name of the project

repoName string optional Nullable

The name of the GitHub repository if this is is a GitHub-connected project.

repoNodeId string optional Nullable

The node ID of the GitHub repository if this is is a GitHub-connected project.

repoUrl string optional Nullable

The URL of the GitHub repository if this is is a GitHub-connected project.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtDeleted": "2019-08-24T14:15:22Z",
  "id": "string",
  "name": "string",
  "repoName": "string",
  "repoNodeId": "string",
  "repoUrl": "string"
}
{
  "code": "string",
  "message": "string"
}

PUT Update a project

/projects/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Update a project

Path Parameters

id string required

The ID of the project to update

Request Body: application/json

name string required

The new name of the project

Request: /projects/{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/projects/{id}"

Responses

200

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

The date the project was created

dtDeleted string (date-time) optional Nullable

The date the project was deleted

id string required

The ID of the project

name string required

The name of the project

repoName string optional Nullable

The name of the GitHub repository if this is is a GitHub-connected project.

repoNodeId string optional Nullable

The node ID of the GitHub repository if this is is a GitHub-connected project.

repoUrl string optional Nullable

The URL of the GitHub repository if this is is a GitHub-connected project.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtDeleted": "2019-08-24T14:15:22Z",
  "id": "string",
  "name": "string",
  "repoName": "string",
  "repoNodeId": "string",
  "repoUrl": "string"
}
{
  "code": "string",
  "message": "string"
}

DELETE Delete a project

/projects/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Delete a project

Path Parameters

id string required

The ID of the project to delete

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

Responses

200

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

The date the project was created

dtDeleted string (date-time) optional Nullable

The date the project was deleted

id string required

The ID of the project

name string required

The name of the project

repoName string optional Nullable

The name of the GitHub repository if this is is a GitHub-connected project.

repoNodeId string optional Nullable

The node ID of the GitHub repository if this is is a GitHub-connected project.

repoUrl string optional Nullable

The URL of the GitHub repository if this is is a GitHub-connected project.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtDeleted": "2019-08-24T14:15:22Z",
  "id": "string",
  "name": "string",
  "repoName": "string",
  "repoNodeId": "string",
  "repoUrl": "string"
}
{
  "code": "string",
  "message": "string"
}

GET List a project's activity

/projects/{id}/activity
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of activity items for a given project.

Path Parameters

id string required

The ID of the project to fetch activity items for

Query Parameters

after string (uuid) 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 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
deploymentId string (uuid) optional

Constrain results to deployment activity.

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

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
action string (enum, 8 values) required

The action that was performed

actor object optional Nullable

The actor that performed the action. Either a use or system.

Show child properties
avatarUrl string optional Nullable

The avatar URL of the actor

email string optional Nullable

The email of the actor

fullName string optional Nullable

The full name of the actor (e.g. "John Doe")

data object optional Nullable

The data associated with the activity item

Show child properties
from number required
to number required
deployment object optional Nullable

The deployment associated with the activity item

Show child properties
dtDeleted string (date-time) required Nullable

The date the deployment was deleted

id string required

The ID of the deployment

name string required

The name of the deployment

dtCreated string (date-time) required

The date the activity item was created

id string (uuid) required

ID of the activity item

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": [
    {
      "action": "deployment.scaled",
      "dtCreated": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

GET List a project's collaborators

/projects/{id}/collaborators
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of collaborators for a project.

Path Parameters

id string required

The ID of the project.

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 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
Request: /projects/{id}/collaborators
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/projects/{id}/collaborators"

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 collaborate was added to the project

dtDeleted string (date-time) optional Nullable

The date the collaborator was removed from the project

user object required

The user that can access the project

Show child properties
email string (email) required

The email address of the user

firstName string optional Nullable

The first name of the user

id string required

The ID of the user

lastName string optional Nullable

The last name of the user

publicProfileImageUrl string optional Nullable

The URL of the team's profile image.

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",
      "dtDeleted": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Create a project collaborator

/projects/{id}/collaborators
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Adds a new collaborator to a project.

Path Parameters

id string required

The ID of the project.

Request Body: application/json

userId string required

The ID of the user to add to the project. This can be found on the user's profile at https://console.paperspace.com/account/settings/profile.

Request: /projects/{id}/collaborators
Content type application/json 
{
  "userId": "string"
}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "string"
}' \
  "https://api.paperspace.com/v1/projects/{id}/collaborators"

Responses

200

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

The date the collaborate was added to the project

dtDeleted string (date-time) optional Nullable

The date the collaborator was removed from the project

user object required

The user that can access the project

Show child properties
email string (email) required

The email address of the user

firstName string optional Nullable

The first name of the user

id string required

The ID of the user

lastName string optional Nullable

The last name of the user

publicProfileImageUrl string optional Nullable

The URL of the team's profile image.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtDeleted": "2019-08-24T14:15:22Z",
  "user": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "publicProfileImageUrl": "string"
  }
}
{
  "code": "string",
  "message": "string"
}

DELETE Delete a project collaborator

/projects/{id}/collaborators/{userId}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Removes a collaborator from a project.

Path Parameters

id string required

The ID of the project.

userId string required

The ID of the user to remove from the project. This can be found on the team members page at https://console.paperspace.com/settings/members.

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

Responses

200

Successful response
Response Schema: application/json
userId string required

The ID of the user removed from the project.

default

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

GET List a project's deployments

/projects/{id}/deployments
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of deployments for a project.

Path Parameters

id string required

The ID of the project to fetch deployments for

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 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

Filter to deployments with names matching this string.

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

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
basicAuthKey string optional Nullable

The endpoint security key for the deployment

dtCreated string (date-time) required

The date the deployment was created

endpoint string required

The unique endpoint for the deployment

id string required

The ID of the deployment

latestSpec object optional Nullable

The latest deployment configuration. If invalid, null is returned.

Show child properties
data anyOf optional Nullable

The data for the deployment spec

One of:
Option 2
apiVersion string, one of: v1, latest required
basicAuthKey string optional
command array of string optional
Additional nested properties not shown. Refer to the full API spec for details.
containerRegistry string optional
enabled boolean optional
env array of object optional
Additional nested properties not shown. Refer to the full API spec for details.
healthChecks object optional
Additional nested properties not shown. Refer to the full API spec for details.
healthchecks object optional
Additional nested properties not shown. Refer to the full API spec for details.
image string required
integrations array of anyOf optional
Additional nested properties not shown. Refer to the full API spec for details.
name string required
region string, one of: ny2, ca1, ams1 optional
resources object required
Additional nested properties not shown. Refer to the full API spec for details.
deploymentId string required

The ID of the deployment the spec belongs to

dtHealthy string (date-time) optional Nullable

The date the deployment was marked "healthy"

error string optional Nullable

The fatal configuration error. Only present if the cluster was unable to apply the entire deployment configuration. This is not the same as an instance error.

externalApplied string (date-time) optional Nullable

The date the deployment configuration was applied to the cluster

id string required

The ID of the deployment spec

metadata object optional Nullable

Metadata about the source of the configuration

Show child properties
gitHeaders object optional
Additional nested properties not shown. Refer to the full API spec for details.
userId string required

The ID of the user the deployment belongs to

latestSpecHash string optional Nullable

The last version hash for the deployment

name string required

The name of the deployment

projectId string required

The ID of the project the deployment belongs to

teamId string required

The ID of the team the deployment belongs to

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": [
    {
      "basicAuthKey": "string",
      "dtCreated": "2019-08-24T14:15:22Z",
      "endpoint": "string",
      "id": "string",
      "latestSpecHash": "string",
      "name": "string",
      "projectId": "string",
      "teamId": "string"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

GET List a project's models

/projects/{id}/models
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of models for a project.

Path Parameters

id string required

The ID of the project to fetch models for

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 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

Filter to models with names matching this string.

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

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
description string required Nullable

The description of the dataset

dtCreated string (date-time) required

The date the dataset was created

dtModified string (date-time) required

The date the dataset was last modified

id string required

The ID of the dataset

isPublic boolean required

Whether the dataset is public

name string required

The name of the dataset

projectId string required Nullable

The ID of the project

storageProviderId string required Nullable

The ID of the storage provider

teamId string required

The ID of the team that owns the dataset

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": [
    {
      "description": "string",
      "dtCreated": "2019-08-24T14:15:22Z",
      "dtModified": "2019-08-24T14:15:22Z",
      "id": "string",
      "isPublic": true,
      "name": "string",
      "projectId": "string",
      "storageProviderId": "string",
      "teamId": "string"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Add a model to a project

/projects/{id}/models/{modelId}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Adds a model to a project.

Path Parameters

id string required

The ID of the project to add the model to

modelId string required

The ID of the model to add to the project. See Create a model.

Request: /projects/{id}/models/{modelId}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  "https://api.paperspace.com/v1/projects/{id}/models/{modelId}"

Responses

200

Successful response
Response Schema: application/json
description string required Nullable

The description of the dataset

dtCreated string (date-time) required

The date the dataset was created

dtModified string (date-time) required

The date the dataset was last modified

id string required

The ID of the dataset

isPublic boolean required

Whether the dataset is public

name string required

The name of the dataset

projectId string required Nullable

The ID of the project

storageProviderId string required Nullable

The ID of the storage provider

teamId string required

The ID of the team that owns the dataset

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "description": "string",
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "id": "string",
  "isPublic": true,
  "name": "string",
  "projectId": "string",
  "storageProviderId": "string",
  "teamId": "string"
}
{
  "code": "string",
  "message": "string"
}

DELETE Remove a model from project

/projects/{id}/models/{modelId}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Remove a model from project.

Path Parameters

id string required

The ID of the project to remove the model from

modelId string required

The ID of the model to remove from the project. See Create a model.

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

Responses

200

Successful response
Response Schema: application/json
description string required Nullable

The description of the dataset

dtCreated string (date-time) required

The date the dataset was created

dtModified string (date-time) required

The date the dataset was last modified

id string required

The ID of the dataset

isPublic boolean required

Whether the dataset is public

name string required

The name of the dataset

projectId string required Nullable

The ID of the project

storageProviderId string required Nullable

The ID of the storage provider

teamId string required

The ID of the team that owns the dataset

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "description": "string",
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "id": "string",
  "isPublic": true,
  "name": "string",
  "projectId": "string",
  "storageProviderId": "string",
  "teamId": "string"
}
{
  "code": "string",
  "message": "string"
}

GET List a project's secrets

/projects/{id}/secrets
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of secrets for a project.

Path Parameters

id string required

The ID of the project where the secret is stored.

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 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
Request: /projects/{id}/secrets
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/projects/{id}/secrets"

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 secret was created.

dtModified string (date-time) required

The date the secret was last modified.

hasDeploymentAttached boolean required
name string required

The name of the secret, e.g. "DB_PASSWORD".

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",
      "dtModified": "2019-08-24T14:15:22Z",
      "hasDeploymentAttached": true,
      "name": "string"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Create a project secret

/projects/{id}/secrets
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Creates a new secret for a project.

Path Parameters

id string required

The ID of the project where the secret is stored.

Request Body: application/json

name string required

The name of the secret, e.g. "DB_PASSWORD".

value string required

The value of the secret, e.g. "password".

Request: /projects/{id}/secrets
Content type application/json 
{
  "name": "string",
  "value": "string"
}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "value": "string"
}' \
  "https://api.paperspace.com/v1/projects/{id}/secrets"

Responses

200

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

The date the secret was created.

dtModified string (date-time) required

The date the secret was last modified.

name string required

The name of the secret, e.g. "DB_PASSWORD".

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "name": "string"
}
{
  "code": "string",
  "message": "string"
}

GET Get a project secret

/projects/{id}/secrets/{name}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a secret for a project.

Path Parameters

id string required

The ID of the project where the secret is stored.

name string required

The name of the secret, e.g. "DB_PASSWORD".

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

Responses

200

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

The date the secret was created.

dtModified string (date-time) required

The date the secret was last modified.

hasDeploymentAttached boolean required
name string required

The name of the secret, e.g. "DB_PASSWORD".

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "hasDeploymentAttached": true,
  "name": "string"
}
{
  "code": "string",
  "message": "string"
}

PATCH Update a project secret

/projects/{id}/secrets/{name}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Update the value of a secret for a project.

Path Parameters

id string required

The ID of the project where the secret is stored.

name string required

The name of the secret, e.g. "DB_PASSWORD".

Request Body: application/json

value string required

The value of the secret, e.g. "password".

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

Responses

200

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

The date the secret was created.

dtModified string (date-time) required

The date the secret was last modified.

name string required

The name of the secret, e.g. "DB_PASSWORD".

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "name": "string"
}
{
  "code": "string",
  "message": "string"
}

DELETE Delete a project secret

/projects/{id}/secrets/{name}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Deletes a secret for a project.

Path Parameters

id string required

The ID of the project where the secret is stored.

name string required

The name of the secret, e.g. "DB_PASSWORD".

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

Responses

200

Successful response
Response Schema: application/json
name string required

The name of the secret, e.g. "DB_PASSWORD".

default

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

GET List a project's tags

/projects/{id}/tags
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of tags for a project.

Path Parameters

id string required

The ID of the project to fetch tags for

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 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
Request: /projects/{id}/tags
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/projects/{id}/tags"

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 notebook was created

id number required

The ID of the tag

name string required

The name of the tag

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": 0,
      "name": "string"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Add a tag to a project

/projects/{id}/tags
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Adds a tag to a project.

Path Parameters

id string required

The ID of the project to add the tag to

Request Body: application/json

name string required

The name of the tag to add to the project

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

Responses

200

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

The date the notebook was created

id number required

The ID of the tag

name string required

The name of the tag

default

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

DELETE Remove a tag from a project

/projects/{id}/tags
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Remove a tag from a project.

Path Parameters

id string required

The ID of the project to remove the tag from

Query Parameters

name string required

The name of the tag to remove from the project

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

Responses

200

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

The date the notebook was created

id number required

The ID of the tag

name string required

The name of the tag

default

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

We can't find any results for your search.

Try using different keywords or simplifying your search terms.