{"openapi":"3.0.0","info":{"description":"Paperspace (a DigitalOcean company) GPU cloud API — manage machines, notebooks, deployments, storage, snapshots and team resources on api.paperspace.com. Verified live 2026-09-04 (Bearer auth, live OpenAPI 3.0.3 spec).","version":"v1"},"servers":[{"description":"Paperspace (a DigitalOcean company) GPU cloud API — manage machines, notebooks, deployments, storage, snapshots and team resources on api.paperspace.com. Verified live 2026-09-04 (Bearer auth, live OpenAPI 3.0.3 spec).","url":"https://api.apirails.com/paperspace"}],"paths":{"/auth/session":{"get":{"tags":["Authentication"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/authentication/#auth-session","api_endpoint":"https://api.paperspace.com/v1/auth/session"},"summary":"Get the current session","description":"Get the current session | Get the current session. If a user is not logged in, this will be null. Otherwise, it will contain the current team and user. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/container-registries":{"post":{"tags":["Container Registries"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/container-registries/#containerRegistries-create","api_endpoint":"https://api.paperspace.com/v1/container-registries"},"summary":"Create a container registry","description":"Create a container registry | Creates a container registry for the current team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"kind":{"type":"string","description":"The kind of provider the registry is. If provided, the registry will be validated against the provider's rules."},"name":{"type":"string","description":"The name of the container registry.","required":true},"namespace":{"type":"string","description":"The namespace of the container registry. See https://docs.digitalocean.com/products/container-registry/.","required":true},"password":{"type":"string","description":"The password for the registry. See https://docs.digitalocean.com/products/container-registry/.","required":true},"url":{"type":"string","description":"The URL of the container registry. See https://docs.digitalocean.com/products/container-registry/.","required":true},"username":{"type":"string","description":"A username for the container registry. See https://docs.digitalocean.com/products/container-registry/.","required":true}}},"example":{"kind":["other"],"name":["string"],"namespace":["string"],"password":["string"],"url":["string"],"username":["string"]}}}}},"get":{"tags":["Container Registries"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/container-registries/#containerRegistries-list","api_endpoint":"https://api.paperspace.com/v1/container-registries"},"summary":"List container registries","description":"List container registries | Lists container registries for the current team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/container-registries/{id}":{"get":{"tags":["Container Registries"],"parameters":[{"name":"id","in":"path","description":"The id of the container registry.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/container-registries/#containerRegistries-get","api_endpoint":"https://api.paperspace.com/v1/container-registries/{id}"},"summary":"Get container registry","description":"List container registries | Lists container registries for the current team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"put":{"tags":["Container Registries"],"parameters":[{"name":"id","in":"path","description":"The id of the container registry.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/container-registries/#containerRegistries-update","api_endpoint":"https://api.paperspace.com/v1/container-registries/{id}"},"summary":"Update a container registry","description":"Update a container registry | Updates a container registry for the current team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"kind":{"type":"string","description":"The kind of provider the registry is. If provided, the registry will be validated against the provider's rules."},"name":{"type":"string","description":"The name of the container registry."},"namespace":{"type":"string","description":"The namespace of the container registry. See https://docs.digitalocean.com/products/container-registry/."},"password":{"type":"string","description":"An updated password for the registry. See https://docs.digitalocean.com/products/container-registry/."},"url":{"type":"string","description":"The URL of the container registry. See https://docs.digitalocean.com/products/container-registry/."},"username":{"type":"string","description":"A username for the container registry. See https://docs.digitalocean.com/products/container-registry/."}}},"example":{"kind":["other"],"name":["string"],"namespace":["string"],"password":["string"],"url":["string"],"username":["string"]}}}}},"delete":{"tags":["Container Registries"],"parameters":[{"name":"id","in":"path","description":"The id of the container registry.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/container-registries/#containerRegistries-delete","api_endpoint":"https://api.paperspace.com/v1/container-registries/{id}"},"summary":"Delete a container registry","description":"Delete a container registry | Deletes a container registry for the current team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/container-registries/{id}/test-connection":{"get":{"tags":["Container Registries"],"parameters":[{"name":"id","in":"path","description":"The id of the container registry.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/container-registries/#containerRegistries-testConnection","api_endpoint":"https://api.paperspace.com/v1/container-registries/{id}/test-connection"},"summary":"Test a container registry connection","description":"Test a container registry connection | Validate that a container registry can be connected to using the provided credentials. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/custom-templates/{id}":{"get":{"tags":["Custom Templates"],"parameters":[{"name":"id","in":"path","description":"The ID of the template to fetch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/custom-templates/#customTemplates-get","api_endpoint":"https://api.paperspace.com/v1/custom-templates/{id}"},"summary":"Get a template","description":"Get a template | Fetches a single template by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"put":{"tags":["Custom Templates"],"parameters":[{"name":"id","in":"path","description":"The ID of the template to update.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/custom-templates/#customTemplates-update","api_endpoint":"https://api.paperspace.com/v1/custom-templates/{id}"},"summary":"Update a template","description":"Update a template | Updates a single template by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the template.","required":true}}},"example":{"name":["string"]}}}}},"delete":{"tags":["Custom Templates"],"parameters":[{"name":"id","in":"path","description":"The ID of the template to delete.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/custom-templates/#customTemplates-delete","api_endpoint":"https://api.paperspace.com/v1/custom-templates/{id}"},"summary":"Delete template","description":"Delete template | Delete a template. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/custom-templates":{"get":{"tags":["Custom Templates"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"machineId","in":"query","description":"machineId (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"name (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated","name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/custom-templates/#customTemplates-list","api_endpoint":"https://api.paperspace.com/v1/custom-templates"},"summary":"List templates","description":"List templates | Fetches a list of templates. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Custom Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/custom-templates/#customTemplates-create","api_endpoint":"https://api.paperspace.com/v1/custom-templates"},"summary":"Create template","description":"Create template | Create a template for a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"machineId":{"type":"string","description":"The ID of the machine to create a template from.","required":true},"name":{"type":"string","description":"The name of the template.","required":true}}},"example":{"machineId":["string"],"name":["string"]}}}}}},"/machine-events/{id}":{"get":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine event to fetch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machineEvents-get","api_endpoint":"https://api.paperspace.com/v1/machine-events/{id}"},"summary":"Get a machine event","description":"Get a machine event | Fetches a single machine event by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/machine-events":{"get":{"tags":["Machine"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"machineId","in":"query","description":"machineId (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machineEvents-list","api_endpoint":"https://api.paperspace.com/v1/machine-events"},"summary":"List machine events","description":"List machine events | Fetches a list of machine events. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/deployments/{id}":{"get":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"The ID of the deployment to fetch","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/deployments/#deployments-get","api_endpoint":"https://api.paperspace.com/v1/deployments/{id}"},"summary":"Get a deployment","description":"Get a deployment | Fetches a single deployment by deployment ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"delete":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"The ID of the deployment to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/deployments/#deployments-delete","api_endpoint":"https://api.paperspace.com/v1/deployments/{id}"},"summary":"Delete a deployment","description":"Delete a deployment | Deletes a deployment by deployment ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/deployments":{"get":{"tags":["Deployments"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/deployments/#deployments-list","api_endpoint":"https://api.paperspace.com/v1/deployments"},"summary":"List deployments","description":"List deployments | Fetches a list of deployments for a logged in user. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Deployments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/deployments/#deployments-upsert","api_endpoint":"https://api.paperspace.com/v1/deployments"},"summary":"Upsert a deployment","description":"Upsert a deployment | Submit a new deployment configuration. If a deployment does not exist, one is created. Otherwise, a deployment is updated with new configuration. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"config":{"type":"object","description":"The deployment configuration","required":true,"properties":{"apiVersion":{"type":"string","description":"body.config.apiVersion (string field from the documented request schema)","required":true},"command":{"type":"array","description":"body.config.command (array field from the documented request schema)"},"containerRegistry":{"type":"string","description":"body.config.containerRegistry (string field from the documented request schema)"},"enabled":{"type":"boolean","description":"body.config.enabled (boolean field from the documented request schema)","enum":[true,false]},"env":{"type":"array","description":"body.config.env (array field from the documented request schema)"},"healthChecks":{"type":"object","description":"body.config.healthChecks (object field from the documented request schema)"},"image":{"type":"string","description":"body.config.image (string field from the documented request schema)","required":true},"models":{"type":"array","description":"body.config.models (array field from the documented request schema)"},"name":{"type":"string","description":"body.config.name (string field from the documented request schema)","required":true},"port":{"type":"number","description":"body.config.port (number field from the documented request schema)"},"region":{"type":"string","description":"body.config.region (string field from the documented request schema)"},"repositories":{"type":"object","description":"body.config.repositories (object field from the documented request schema)"},"resources":{"type":"object","description":"body.config.resources (object field from the documented request schema)","required":true}}},"deploymentId":{"type":"string","description":"The ID of the deployment to update."},"projectId":{"type":"string","description":"The project ID to deploy resources under.","required":true}}},"example":{"config":[{"apiVersion":"v0alpha0","command":["string"],"containerRegistry":"string","enabled":true,"env":[{"name":"string","value":"string"}],"healthChecks":{"liveness":{"path":"string","failureThreshold":0,"headers":[{}],"host":"string","initialDelaySeconds":0,"periodSeconds":0,"port":0,"timeoutSeconds":0},"readiness":{"path":"string","failureThreshold":0,"headers":[{}],"host":"string","initialDelaySeconds":0,"periodSeconds":0,"port":0,"timeoutSeconds":0},"startup":{"path":"string","failureThreshold":0,"headers":[{}],"host":"string","initialDelaySeconds":0,"periodSeconds":0,"port":0,"timeoutSeconds":0}},"image":"string","models":[{"path":"string","id":"string"}],"name":"string","port":80,"region":"ny2","repositories":{"dataset":"string","mountPath":"string","repositories":[{"name":"string","password":"string","ref":"string","url":"string","username":"string"}]}}],"deploymentId":["string"],"projectId":["string"]}}}}}},"/deployments/{id}/runs":{"get":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"The ID of the deployment to fetch","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The latest n number of deployment runs to return","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/deployments/#deploymentRuns-get","api_endpoint":"https://api.paperspace.com/v1/deployments/{id}/runs"},"summary":"List deployment runs","description":"List deployment runs | Lists the active deployment runs for a deployment. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/deployments/{id}/metrics":{"get":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"The ID of the deployment to fetch","required":true,"schema":{"type":"string","example":""}},{"name":"metric","in":"query","description":"The metric to fetch.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["requests_total"]}}},{"name":"timeframe","in":"query","description":"The time frame for the metrics request.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["hour","12_hours","day","1_week","2_weeks"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/deployments/#deploymentMetrics-get","api_endpoint":"https://api.paperspace.com/v1/deployments/{id}/metrics"},"summary":"List deployment metrics","description":"List deployment metrics | Lists metrics for a given deployment. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/deployments/{id}/logs":{"get":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"The ID of the deployment","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"instanceId","in":"query","description":"Get the logs for a particular instance ID","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/deployments/#deploymentLogs-list","api_endpoint":"https://api.paperspace.com/v1/deployments/{id}/logs"},"summary":"List deployment logs","description":"List deployment logs | Lists logs for a given deployment. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/deployments/{id}/history":{"get":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"The ID of the deployment","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/deployments/#deploymentHistory-list","api_endpoint":"https://api.paperspace.com/v1/deployments/{id}/history"},"summary":"List deployment history","description":"List deployment history | Lists history for a given deployment. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/machine-availability":{"get":{"tags":["Machine Types"],"parameters":[{"name":"machineType","in":"query","description":"Filter to machine availabilities with machine types matching this string.","required":true,"schema":{"type":"string","example":""}},{"name":"region","in":"query","description":"Filter to machine availabilities in this region.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ny2"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine-types/#machineAvailability-list","api_endpoint":"https://api.paperspace.com/v1/machine-availability"},"summary":"Get machine availability","description":"Get machine availability | Gets the machine availability for a given region and machine type. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/machines":{"post":{"tags":["Machine"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-create","api_endpoint":"https://api.paperspace.com/v1/machines"},"summary":"Create a machine","description":"Create a machine | Creates a new machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"accessorIds":{"type":"array","description":"The IDs of users to grant access to the machine.","items":{"type":"string"}},"autoShutdownEnabled":{"type":"boolean","description":"Whether to enable auto shutdown.","enum":[true,false]},"autoShutdownForce":{"type":"boolean","description":"Whether to force shutdown the machine.","enum":[true,false]},"autoShutdownTimeout":{"type":"number","description":"The auto shutdown timeout in hours."},"autoSnapshotEnabled":{"type":"boolean","description":"Whether to enable auto snapshots.","enum":[true,false]},"autoSnapshotFrequency":{"type":"string","description":"The auto snapshot frequency."},"autoSnapshotSaveCount":{"type":"number","description":"The number of auto snapshots to save."},"diskSize":{"type":"number","description":"The disk size in gigabytes.","required":true},"emailPassword":{"type":"boolean","description":"Whether to email the password.","enum":[true,false]},"enableNvlink":{"type":"boolean","description":"Whether to enable NVLink.","enum":[true,false]},"machineType":{"type":"string","description":"The machine type. This must correspond to a machine type label as indicated in List OS templates or List templates.","required":true},"name":{"type":"string","description":"The name of the new machine.","required":true},"networkId":{"type":"string","description":"The network ID."},"publicIpType":{"type":"string","description":"The public IP type."},"region":{"type":"string","description":"The region to create the machine in.","required":true},"restorePointEnabled":{"type":"boolean","description":"Whether to use initial snapshot as a restore point.","enum":[true,false]},"restorePointFrequency":{"type":"string","description":"The restore point frequency."},"startOnCreate":{"type":"boolean","description":"Whether to start the machine on creation.","enum":[true,false]},"startupScriptId":{"type":"string","description":"The startup script ID."},"takeInitialSnapshot":{"type":"boolean","description":"Whether to take an initial snapshot.","enum":[true,false]},"templateId":{"type":"string","description":"The template ID. See List OS templates or List templates.","required":true}}},"example":{"accessorIds":[["string"]],"autoShutdownEnabled":[false],"autoShutdownForce":[false],"autoShutdownTimeout":[0],"autoSnapshotEnabled":[false],"autoSnapshotFrequency":["hourly"],"autoSnapshotSaveCount":[0],"diskSize":[50],"emailPassword":[true],"enableNvlink":[false],"machineType":["string"],"name":["string"],"networkId":["string"],"publicIpType":["static"],"region":["ny2"],"restorePointEnabled":[false],"restorePointFrequency":["shutdown"],"startOnCreate":[false],"startupScriptId":["string"],"takeInitialSnapshot":[false],"templateId":["string"]}}}}},"get":{"tags":["Machine"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"agentType","in":"query","description":"agentType (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"machineType","in":"query","description":"machineType (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"name (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated","name","state"]}}},{"name":"region","in":"query","description":"region (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ny2"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-list","api_endpoint":"https://api.paperspace.com/v1/machines"},"summary":"List machines","description":"List machines | Fetches a list of machines. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/machines/{id}":{"delete":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine to delete.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-delete","api_endpoint":"https://api.paperspace.com/v1/machines/{id}"},"summary":"Delete a machine","description":"Delete a machine | Deletes a single machine by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine to fetch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-get","api_endpoint":"https://api.paperspace.com/v1/machines/{id}"},"summary":"Get a machine","description":"Get a machine | Fetches a single machine by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"put":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine to update.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-update","api_endpoint":"https://api.paperspace.com/v1/machines/{id}"},"summary":"Update a machine","description":"Update a machine | Updates a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"autoShutdownEnabled":{"type":"boolean","description":"Whether to enable auto shutdown.","enum":[true,false]},"autoShutdownForce":{"type":"boolean","description":"Whether to force shutdown the machine.","enum":[true,false]},"autoShutdownTimeout":{"type":"number","description":"The auto shutdown timeout in hours."},"autoSnapshotEnabled":{"type":"boolean","description":"Whether to enable auto snapshots.","enum":[true,false]},"autoSnapshotFrequency":{"type":"string","description":"The auto snapshot frequency."},"autoSnapshotSaveCount":{"type":"number","description":"The number of auto snapshots to save."},"diskSize":{"type":"number","description":"The disk size in gigabytes."},"machineType":{"type":"string","description":"The machine type. This must correspond to a machine type label as indicated in List OS templates or List templates."},"name":{"type":"string","description":"The name of the machine."},"networkId":{"type":"string","description":"The network ID."},"publicIpType":{"type":"string","description":"The public IP type."},"restorePointEnabled":{"type":"boolean","description":"Whether to use initial snapshot as a restore point.","enum":[true,false]},"restorePointFrequency":{"type":"string","description":"The restore point frequency."},"restorePointSnapshotId":{"type":"string","description":"The restore point snapshot ID."}}},"example":{"autoShutdownEnabled":[false],"autoShutdownForce":[false],"autoShutdownTimeout":[0],"autoSnapshotEnabled":[false],"autoSnapshotFrequency":["hourly"],"autoSnapshotSaveCount":[0],"diskSize":[50],"machineType":["string"],"name":["string"],"networkId":["string"],"publicIpType":["static"],"restorePointEnabled":[false],"restorePointFrequency":["shutdown"],"restorePointSnapshotId":["string"]}}}}}},"/machines/{id}/restart":{"patch":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine to restart.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-restart","api_endpoint":"https://api.paperspace.com/v1/machines/{id}/restart"},"summary":"Restart a machine","description":"Restart a machine | Restarts a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/machines/{id}/start":{"patch":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine to start.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-start","api_endpoint":"https://api.paperspace.com/v1/machines/{id}/start"},"summary":"Start a machine","description":"Start a machine | Starts a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/machines/{id}/stop":{"patch":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine to stop.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-stop","api_endpoint":"https://api.paperspace.com/v1/machines/{id}/stop"},"summary":"Stop a machine","description":"Stop a machine | Stops a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/machines/{id}/accessors":{"post":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine to add an accessor to.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-addAccessor","api_endpoint":"https://api.paperspace.com/v1/machines/{id}/accessors"},"summary":"Add an accessor","description":"Add an accessor | Adds an accessor to a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"userId":{"type":"string","description":"The ID of the user to add as an accessor. This can be found on the team members page at https://console.paperspace.com/settings/members.","required":true}}},"example":{"userId":["string"]}}}}},"get":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-listAccessors","api_endpoint":"https://api.paperspace.com/v1/machines/{id}/accessors"},"summary":"List accessors","description":"List accessors | Lists the team members that can explicitly access a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/machines/{id}/accessors/{userId}":{"delete":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine to add an accessor to.","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"The ID of the user to add as an accessor. This can be found on the team members page at https://console.paperspace.com/settings/members.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-removeAccessor","api_endpoint":"https://api.paperspace.com/v1/machines/{id}/accessors/{userId}"},"summary":"Delete an accessor","description":"Delete an accessor | Deletes an accessor from a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine to get an accessor for.","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"The ID of the user to get. This can be found on the team members page at https://console.paperspace.com/settings/members.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-getAccessor","api_endpoint":"https://api.paperspace.com/v1/machines/{id}/accessors/{userId}"},"summary":"Get an accessor","description":"Get an accessor | Get an accessor for a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/machines/{id}/desktop":{"get":{"tags":["Machine"],"parameters":[{"name":"id","in":"path","description":"The ID of the machine.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/machine/#machines-getDesktop","api_endpoint":"https://api.paperspace.com/v1/machines/{id}/desktop"},"summary":"Get desktop settings","description":"Get desktop settings | Gets the machine settings that are used to configure desktop streaming. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/private-networks/{id}":{"get":{"tags":["Private Networks"],"parameters":[{"name":"id","in":"path","description":"The ID of the private network to fetch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/private-networks/#privateNetworks-get","api_endpoint":"https://api.paperspace.com/v1/private-networks/{id}"},"summary":"Get a private network","description":"Get a private network | Fetches a single private network by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"put":{"tags":["Private Networks"],"parameters":[{"name":"id","in":"path","description":"The ID of the private network to update.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/private-networks/#privateNetworks-update","api_endpoint":"https://api.paperspace.com/v1/private-networks/{id}"},"summary":"Update a private network","description":"Update a private network | Updates a single private network by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the private network."}}},"example":{"name":["string"]}}}}},"delete":{"tags":["Private Networks"],"parameters":[{"name":"id","in":"path","description":"The ID of the private network to delete.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/private-networks/#privateNetworks-delete","api_endpoint":"https://api.paperspace.com/v1/private-networks/{id}"},"summary":"Delete a private network","description":"Delete a private network | Deletes a single private network by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/private-networks":{"get":{"tags":["Private Networks"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"name (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated","name"]}}},{"name":"region","in":"query","description":"region (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ny2"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/private-networks/#privateNetworks-list","api_endpoint":"https://api.paperspace.com/v1/private-networks"},"summary":"List private networks","description":"List private networks | Fetches a list of private networks. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Private Networks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/private-networks/#privateNetworks-create","api_endpoint":"https://api.paperspace.com/v1/private-networks"},"summary":"Create a private network","description":"Create a private network | Creates a new private network. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"migrateMachines":{"type":"boolean","description":"Whether to migrate all machines not currently in a private network to the new private network.","enum":[true,false]},"name":{"type":"string","description":"The name of the private network.","required":true},"region":{"type":"string","description":"The region the private network is in.","required":true}}},"example":{"migrateMachines":[false],"name":["string"],"region":["ny2"]}}}}}},"/projects":{"post":{"tags":["Projects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projects-create","api_endpoint":"https://api.paperspace.com/v1/projects"},"summary":"Create a project","description":"Create a project | Create a project | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the project","required":true}}},"example":{"name":["string"]}}}}},"get":{"tags":["Projects"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projects-list","api_endpoint":"https://api.paperspace.com/v1/projects"},"summary":"List projects","description":"List projects | List projects. This endpoint supports pagination and sorting. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/projects/{id}":{"get":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to get","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projects-get","api_endpoint":"https://api.paperspace.com/v1/projects/{id}"},"summary":"Get a project by its ID","description":"Get a project by its ID | Get a project by its ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"put":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projects-update","api_endpoint":"https://api.paperspace.com/v1/projects/{id}"},"summary":"Update a project","description":"Update a project | Update a project | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The new name of the project","required":true}}},"example":{"name":["string"]}}}}},"delete":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projects-delete","api_endpoint":"https://api.paperspace.com/v1/projects/{id}"},"summary":"Delete a project","description":"Delete a project | Delete a project | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/projects/{id}/activity":{"get":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to fetch activity items for","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"deploymentId","in":"query","description":"Constrain results to deployment activity.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectActivity-list","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/activity"},"summary":"List a project's activity","description":"List a project's activity | Fetches a list of activity items for a given project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/projects/{id}/collaborators":{"get":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectCollaborators-list","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/collaborators"},"summary":"List a project's collaborators","description":"List a project's collaborators | Fetches a list of collaborators for a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectCollaborators-create","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/collaborators"},"summary":"Create a project collaborator","description":"Create a project collaborator | Adds a new collaborator to a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"userId":{"type":"string","description":"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.","required":true}}},"example":{"userId":["string"]}}}}}},"/projects/{id}/collaborators/{userId}":{"delete":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectCollaborators-delete","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/collaborators/{userId}"},"summary":"Delete a project collaborator","description":"Delete a project collaborator | Removes a collaborator from a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/projects/{id}/deployments":{"get":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to fetch deployments for","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"Filter to deployments with names matching this string.","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectDeployments-list","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/deployments"},"summary":"List a project's deployments","description":"List a project's deployments | Fetches a list of deployments for a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/projects/{id}/models":{"get":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to fetch models for","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"Filter to models with names matching this string.","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectModels-list","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/models"},"summary":"List a project's models","description":"List a project's models | Fetches a list of models for a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/projects/{id}/models/{modelId}":{"post":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to add the model to","required":true,"schema":{"type":"string","example":""}},{"name":"modelId","in":"path","description":"The ID of the model to add to the project. See Create a model.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectModels-add","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/models/{modelId}"},"summary":"Add a model to a project","description":"Add a model to a project | Adds a model to a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to remove the model from","required":true,"schema":{"type":"string","example":""}},{"name":"modelId","in":"path","description":"The ID of the model to remove from the project. See Create a model.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectModels-remove","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/models/{modelId}"},"summary":"Remove a model from project","description":"Remove a model from project | Remove a model from project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/projects/{id}/secrets":{"get":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project where the secret is stored.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectSecrets-list","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/secrets"},"summary":"List a project's secrets","description":"List a project's secrets | Fetches a list of secrets for a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project where the secret is stored.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectSecrets-create","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/secrets"},"summary":"Create a project secret","description":"Create a project secret | Creates a new secret for a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the secret, e.g. \"DB_PASSWORD\".","required":true},"value":{"type":"string","description":"The value of the secret, e.g. \"password\".","required":true}}},"example":{"name":["string"],"value":["string"]}}}}}},"/projects/{id}/secrets/{name}":{"get":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project where the secret is stored.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"The name of the secret, e.g. \"DB_PASSWORD\".","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectSecrets-getProjectSecret","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/secrets/{name}"},"summary":"Get a project secret","description":"Get a project secret | Fetches a secret for a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"patch":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project where the secret is stored.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"The name of the secret, e.g. \"DB_PASSWORD\".","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectSecrets-update","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/secrets/{name}"},"summary":"Update a project secret","description":"Update a project secret | Update the value of a secret for a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"value":{"type":"string","description":"The value of the secret, e.g. \"password\".","required":true}}},"example":{"value":["string"]}}}}},"delete":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project where the secret is stored.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"The name of the secret, e.g. \"DB_PASSWORD\".","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectSecrets-delete","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/secrets/{name}"},"summary":"Delete a project secret","description":"Delete a project secret | Deletes a secret for a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/projects/{id}/tags":{"get":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to fetch tags for","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectTags-list","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/tags"},"summary":"List a project's tags","description":"List a project's tags | Fetches a list of tags for a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to add the tag to","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectTags-add","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/tags"},"summary":"Add a tag to a project","description":"Add a tag to a project | Adds a tag to a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the tag to add to the project","required":true}}},"example":{"name":["string"]}}}}},"delete":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The ID of the project to remove the tag from","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"The name of the tag to remove from the project","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/projects/#projectTags-remove","api_endpoint":"https://api.paperspace.com/v1/projects/{id}/tags"},"summary":"Remove a tag from a project","description":"Remove a tag from a project | Remove a tag from a project. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/datasets":{"post":{"tags":["Dataset"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasets-create","api_endpoint":"https://api.paperspace.com/v1/datasets"},"summary":"Create a dataset","description":"Create a dataset | Create a dataset | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the dataset"},"isPublic":{"type":"boolean","description":"Whether the dataset is public","required":true,"enum":[true,false]},"name":{"type":"string","description":"The name of the dataset","required":true},"storageProviderId":{"type":"string","description":"The ID of the storage provider"}}},"example":{"description":["string"],"isPublic":[false],"name":["string"],"storageProviderId":["string"]}}}}},"get":{"tags":["Dataset"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}},{"name":"privacy","in":"query","description":"privacy (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["PUBLIC","PRIVATE"]}}},{"name":"teamId","in":"query","description":"teamId (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasets-list","api_endpoint":"https://api.paperspace.com/v1/datasets"},"summary":"List datasets","description":"List datasets | List datasets | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/datasets/{id}":{"get":{"tags":["Dataset"],"parameters":[{"name":"id","in":"path","description":"The ID of the dataset","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasets-get","api_endpoint":"https://api.paperspace.com/v1/datasets/{id}"},"summary":"Get a dataset","description":"Get a dataset | Get a dataset | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"delete":{"tags":["Dataset"],"parameters":[{"name":"id","in":"path","description":"The ID of the dataset","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasets-delete","api_endpoint":"https://api.paperspace.com/v1/datasets/{id}"},"summary":"Delete a dataset","description":"Delete a dataset | Delete a dataset | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Dataset"],"parameters":[{"name":"id","in":"path","description":"The ID of the dataset","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasets-update","api_endpoint":"https://api.paperspace.com/v1/datasets/{id}"},"summary":"Update a dataset","description":"Update a dataset | Update a dataset | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the dataset"},"name":{"type":"string","description":"The name of the dataset"}}},"example":{"description":["string"],"name":["string"]}}}}}},"/datasets/{datasetId}/versions":{"post":{"tags":["Dataset"],"parameters":[{"name":"datasetId","in":"path","description":"The ID of the dataset","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasetVersions-create","api_endpoint":"https://api.paperspace.com/v1/datasets/{datasetId}/versions"},"summary":"Create a dataset version","description":"Create a dataset version | Create a dataset version | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"The description of the dataset version"},"metadata":{"type":"object","description":"Metadata for the version.","properties":{}},"tags":{"type":"string","description":"The tags for the version, comma-delimited"}}},"example":{"message":["string"],"metadata":[{}],"tags":["string"]}}}}},"get":{"tags":["Dataset"],"parameters":[{"name":"datasetId","in":"path","description":"The ID of the dataset","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}},{"name":"tags","in":"query","description":"tags (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasetVersions-list","api_endpoint":"https://api.paperspace.com/v1/datasets/{datasetId}/versions"},"summary":"List dataset versions","description":"List dataset versions | List dataset versions | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/datasets/{datasetId}/versions/{version}":{"get":{"tags":["Dataset"],"parameters":[{"name":"datasetId","in":"path","description":"The ID of the dataset","required":true,"schema":{"type":"string","example":""}},{"name":"version","in":"path","description":"The version of the dataset","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasetVersions-get","api_endpoint":"https://api.paperspace.com/v1/datasets/{datasetId}/versions/{version}"},"summary":"Get a dataset version","description":"Get a dataset version | Get a dataset version | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"delete":{"tags":["Dataset"],"parameters":[{"name":"datasetId","in":"path","description":"The ID of the dataset","required":true,"schema":{"type":"string","example":""}},{"name":"version","in":"path","description":"The version of the dataset","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasetVersions-delete","api_endpoint":"https://api.paperspace.com/v1/datasets/{datasetId}/versions/{version}"},"summary":"Delete a dataset version","description":"Delete a dataset version | Delete a dataset version | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Dataset"],"parameters":[{"name":"datasetId","in":"path","description":"The ID of the dataset","required":true,"schema":{"type":"string","example":""}},{"name":"version","in":"path","description":"The version of the dataset","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/dataset/#datasetVersions-update","api_endpoint":"https://api.paperspace.com/v1/datasets/{datasetId}/versions/{version}"},"summary":"Update a dataset version","description":"Update a dataset version | Update a dataset version | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"isCommitted":{"type":"boolean","description":"Whether the version is committed","enum":[true,false]},"message":{"type":"string","description":"The description of the dataset version"},"metadata":{"type":"object","description":"Metadata for the version.","properties":{}},"tags":{"type":"string","description":"The tags for the version, comma-delimited"}}},"example":{"isCommitted":[false],"message":["string"],"metadata":[{}],"tags":["string"]}}}}}},"/models":{"post":{"tags":["Model"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/model/#models-create","api_endpoint":"https://api.paperspace.com/v1/models"},"summary":"Create a model","description":"Create a model | Create a model | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the model"},"isPublic":{"type":"boolean","description":"Whether the model is public","required":true,"enum":[true,false]},"name":{"type":"string","description":"The name of the model","required":true},"projectId":{"type":"string","description":"The ID of the project"},"storageProviderId":{"type":"string","description":"The ID of the storage provider"}}},"example":{"description":["string"],"isPublic":[false],"name":["string"],"projectId":["string"],"storageProviderId":["string"]}}}}},"get":{"tags":["Model"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}},{"name":"projectId","in":"query","description":"projectId (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/model/#models-list","api_endpoint":"https://api.paperspace.com/v1/models"},"summary":"List models","description":"List models | List models | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/models/{id}":{"get":{"tags":["Model"],"parameters":[{"name":"id","in":"path","description":"The ID of the model","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/model/#models-get","api_endpoint":"https://api.paperspace.com/v1/models/{id}"},"summary":"Get a model","description":"Get a model | Get a model | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"delete":{"tags":["Model"],"parameters":[{"name":"id","in":"path","description":"The ID of the model","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/model/#models-delete","api_endpoint":"https://api.paperspace.com/v1/models/{id}"},"summary":"Delete a model","description":"Delete a model | Delete a model | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/os-templates":{"get":{"tags":["OS Templates"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"name (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/os-templates/#osTemplates-list","api_endpoint":"https://api.paperspace.com/v1/os-templates"},"summary":"List OS templates","description":"List OS templates | Fetches a list of OS templates. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/public-ips":{"get":{"tags":["Public IPs"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}},{"name":"region","in":"query","description":"region (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ny2"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/public-ips/#publicIps-list","api_endpoint":"https://api.paperspace.com/v1/public-ips"},"summary":"List public IPs","description":"List public IPs | Fetches a list of public IPs. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Public IPs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/public-ips/#publicIps-claim","api_endpoint":"https://api.paperspace.com/v1/public-ips"},"summary":"Claim a public IP","description":"Claim a public IP | Claims a public IP. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"region":{"type":"string","description":"The region of the public IP.","required":true}}},"example":{"region":["ny2"]}}}}}},"/public-ips/{ip}":{"put":{"tags":["Public IPs"],"parameters":[{"name":"ip","in":"path","description":"The IP address of the public IP.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/public-ips/#publicIps-assign","api_endpoint":"https://api.paperspace.com/v1/public-ips/{ip}"},"summary":"Assign a public IP","description":"Assign a public IP | Assigns a public IP to a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"machineId":{"type":"string","description":"The ID of the machine to assign the public IP to.","required":true}}},"example":{"machineId":["string"]}}}}},"delete":{"tags":["Public IPs"],"parameters":[{"name":"ip","in":"path","description":"The IP address of the public IP.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/public-ips/#publicIps-release","api_endpoint":"https://api.paperspace.com/v1/public-ips/{ip}"},"summary":"Release a public IP","description":"Release a public IP | Releases a public IP. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/shared-drives/{id}":{"get":{"tags":["Shared Drives"],"parameters":[{"name":"id","in":"path","description":"The ID of the shared drive to fetch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/shared-drives/#sharedDrives-get","api_endpoint":"https://api.paperspace.com/v1/shared-drives/{id}"},"summary":"Get a shared drive","description":"Get a shared drive | Fetches a single shared drive by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"put":{"tags":["Shared Drives"],"parameters":[{"name":"id","in":"path","description":"The ID of the shared drive to fetch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/shared-drives/#sharedDrives-update","api_endpoint":"https://api.paperspace.com/v1/shared-drives/{id}"},"summary":"Update a shared drive","description":"Update a shared drive | Updates a single shared drive by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the shared drive."}}},"example":{"name":["string"]}}}}},"delete":{"tags":["Shared Drives"],"parameters":[{"name":"id","in":"path","description":"The ID of the shared drive to delete.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/shared-drives/#sharedDrives-delete","api_endpoint":"https://api.paperspace.com/v1/shared-drives/{id}"},"summary":"Delete a shared drive","description":"Delete a shared drive | Deletes a single shared drive by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/shared-drives":{"get":{"tags":["Shared Drives"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"name (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated","name"]}}},{"name":"region","in":"query","description":"region (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/shared-drives/#sharedDrives-list","api_endpoint":"https://api.paperspace.com/v1/shared-drives"},"summary":"List shared drives","description":"List shared drives | Fetches a list of shared drives. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Shared Drives"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/shared-drives/#sharedDrives-create","api_endpoint":"https://api.paperspace.com/v1/shared-drives"},"summary":"Create a shared drive","description":"Create a shared drive | Creates a new shared drive for use in a private network. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the shared drive.","required":true},"networkId":{"type":"string","description":"The ID of the network the shared drive is in.","required":true},"region":{"type":"string","description":"The region the shared drive is in.","required":true},"size":{"type":"number","description":"The size of the shared drive in gigabytes.","required":true}}},"example":{"name":["string"],"networkId":["string"],"region":["string"],"size":[50]}}}}}},"/snapshots/{id}":{"get":{"tags":["Snapshots"],"parameters":[{"name":"id","in":"path","description":"The ID of the snapshot.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/snapshots/#snapshots-get","api_endpoint":"https://api.paperspace.com/v1/snapshots/{id}"},"summary":"Get a snapshot","description":"Get a snapshot | Fetches a single snapshot by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"put":{"tags":["Snapshots"],"parameters":[{"name":"id","in":"path","description":"The ID of the snapshot.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/snapshots/#snapshots-update","api_endpoint":"https://api.paperspace.com/v1/snapshots/{id}"},"summary":"Update a snapshot","description":"Update a snapshot | Updates a single snapshot by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The updated name of the snapshot."}}},"example":{"name":["string"]}}}}},"delete":{"tags":["Snapshots"],"parameters":[{"name":"id","in":"path","description":"The ID of the snapshot.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/snapshots/#snapshots-delete","api_endpoint":"https://api.paperspace.com/v1/snapshots/{id}"},"summary":"Delete snapshot","description":"Delete snapshot | Delete a snapshot for a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/snapshots":{"get":{"tags":["Snapshots"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"machineId","in":"query","description":"machineId (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated","name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/snapshots/#snapshots-list","api_endpoint":"https://api.paperspace.com/v1/snapshots"},"summary":"List snapshots","description":"List snapshots | List snapshots and filter by machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Snapshots"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/snapshots/#snapshots-create","api_endpoint":"https://api.paperspace.com/v1/snapshots"},"summary":"Create snapshot","description":"Create snapshot | Create a snapshot for a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"machineId":{"type":"string","description":"The ID of the machine to create a snapshot for.","required":true},"name":{"type":"string","description":"The name of the snapshot.","required":true}}},"example":{"machineId":["string"],"name":["string"]}}}}}},"/snapshots/{id}/restore":{"post":{"tags":["Snapshots"],"parameters":[{"name":"id","in":"path","description":"The ID of the snapshot.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/snapshots/#snapshots-restore","api_endpoint":"https://api.paperspace.com/v1/snapshots/{id}/restore"},"summary":"Restore snapshot","description":"Restore snapshot | Restore a snapshot for a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"createSnapshotBeforeRestore":{"type":"boolean","description":"Create a new snapshot before restoring.","enum":[true,false]}}},"example":{"createSnapshotBeforeRestore":[false]}}}}}},"/startup-scripts/{id}":{"get":{"tags":["Startup Scripts"],"parameters":[{"name":"id","in":"path","description":"The ID of the startup script to fetch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/startup-scripts/#startupScripts-get","api_endpoint":"https://api.paperspace.com/v1/startup-scripts/{id}"},"summary":"Get a startup script","description":"Get a startup script | Fetches a single startup script by ID. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"put":{"tags":["Startup Scripts"],"parameters":[{"name":"id","in":"path","description":"The id of the startup script.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/startup-scripts/#startupScripts-update","api_endpoint":"https://api.paperspace.com/v1/startup-scripts/{id}"},"summary":"Update startup script","description":"Update startup script | Update a startup script. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"isEnabled":{"type":"boolean","description":"Whether the startup script is enabled.","enum":[true,false]},"isRunOnce":{"type":"boolean","description":"Whether the script should only run once on first boot or on every boot.","enum":[true,false]},"name":{"type":"string","description":"The name of the startup script."},"script":{"type":"string","description":"The script to run on startup."}}},"example":{"isEnabled":[false],"isRunOnce":[false],"name":["string"],"script":["string"]}}}}},"delete":{"tags":["Startup Scripts"],"parameters":[{"name":"id","in":"path","description":"The id of the startup script.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/startup-scripts/#startupScripts-delete","api_endpoint":"https://api.paperspace.com/v1/startup-scripts/{id}"},"summary":"Delete startup script","description":"Delete startup script | Delete a startup script. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/startup-scripts":{"get":{"tags":["Startup Scripts"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"name (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated","name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/startup-scripts/#startupScripts-list","api_endpoint":"https://api.paperspace.com/v1/startup-scripts"},"summary":"List startup scripts","description":"List startup scripts | Fetches a list of startup scripts. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Startup Scripts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/startup-scripts/#startupScripts-create","api_endpoint":"https://api.paperspace.com/v1/startup-scripts"},"summary":"Create startup script","description":"Create startup script | Create a startup script. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"isRunOnce":{"type":"boolean","description":"Whether the script should only run once on first boot or on every boot.","enum":[true,false]},"name":{"type":"string","description":"The name of the startup script.","required":true},"script":{"type":"string","description":"The script to run on startup.","required":true}}},"example":{"isRunOnce":[false],"name":["string"],"script":["string"]}}}}}},"/startup-scripts/{id}/assign":{"post":{"tags":["Startup Scripts"],"parameters":[{"name":"id","in":"path","description":"The id of the startup script.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/startup-scripts/#startupScripts-assign","api_endpoint":"https://api.paperspace.com/v1/startup-scripts/{id}/assign"},"summary":"Assign startup script to machine","description":"Assign startup script to machine | Assign a startup script to a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"machineId":{"type":"string","description":"The id of the machine to assign the startup script to.","required":true}}},"example":{"machineId":["string"]}}}}}},"/startup-scripts/{id}/unassign":{"post":{"tags":["Startup Scripts"],"parameters":[{"name":"id","in":"path","description":"The id of the startup script.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/startup-scripts/#startupScripts-unassign","api_endpoint":"https://api.paperspace.com/v1/startup-scripts/{id}/unassign"},"summary":"Unassign startup script from machine","description":"Unassign startup script from machine | Unassign a startup script from a machine. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"machineId":{"type":"string","description":"The id of the machine to unassign the startup script from.","required":true}}},"example":{"machineId":["string"]}}}}}},"/storage-providers":{"post":{"tags":["Storage"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/storage/#storageProviders-create","api_endpoint":"https://api.paperspace.com/v1/storage-providers"},"summary":"Create a storage provider","description":"Create a storage provider | Create a storage provider | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"isTeamDefault":{"type":"boolean","description":"Is team default","enum":[true,false]},"name":{"type":"string","description":"The name of the storage provider","required":true},"s3Config":{"type":"object","description":"The storage provider configuration","required":true,"properties":{"accessKey":{"type":"string","description":"body.s3Config.accessKey (string field from the documented request schema)","required":true},"bucket":{"type":"string","description":"body.s3Config.bucket (string field from the documented request schema)","required":true},"endpoint":{"type":"string","description":"body.s3Config.endpoint (string field from the documented request schema)"},"region":{"type":"string","description":"body.s3Config.region (string field from the documented request schema)"},"retainData":{"type":"boolean","description":"body.s3Config.retainData (boolean field from the documented request schema)","enum":[true,false]},"secretAccessKey":{"type":"string","description":"body.s3Config.secretAccessKey (string field from the documented request schema)","required":true},"signatureVersion":{"type":"string","description":"body.s3Config.signatureVersion (string field from the documented request schema)"}}},"storageProviderType":{"type":"string","description":"The type of storage provider","required":true}}},"example":{"isTeamDefault":[false],"name":["string"],"s3Config":[{"accessKey":"string","bucket":"string","endpoint":"string","region":"ny2","retainData":false,"secretAccessKey":"string","signatureVersion":"string"}],"storageProviderType":["s3"]}}}}},"get":{"tags":["Storage"],"parameters":[{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/storage/#storageProviders-list","api_endpoint":"https://api.paperspace.com/v1/storage-providers"},"summary":"List storage providers","description":"List storage providers | List storage providers | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/storage-providers/{id}":{"put":{"tags":["Storage"],"parameters":[{"name":"id","in":"path","description":"The ID of the storage provider","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/storage/#storageProviders-update","api_endpoint":"https://api.paperspace.com/v1/storage-providers/{id}"},"summary":"Update a storage provider","description":"Update a storage provider | Update a storage provider | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"isTeamDefault":{"type":"boolean","description":"Is team default","required":true,"enum":[true,false]},"name":{"type":"string","description":"The name of the storage provider","required":true},"s3Config":{"type":"object","description":"The storage provider configuration","required":true,"properties":{"accessKey":{"type":"string","description":"body.s3Config.accessKey (string field from the documented request schema)","required":true},"bucket":{"type":"string","description":"body.s3Config.bucket (string field from the documented request schema)","required":true},"endpoint":{"type":"string","description":"body.s3Config.endpoint (string field from the documented request schema)"},"region":{"type":"string","description":"body.s3Config.region (string field from the documented request schema)"},"retainData":{"type":"boolean","description":"body.s3Config.retainData (boolean field from the documented request schema)","enum":[true,false]},"secretAccessKey":{"type":"string","description":"body.s3Config.secretAccessKey (string field from the documented request schema)","required":true},"signatureVersion":{"type":"string","description":"body.s3Config.signatureVersion (string field from the documented request schema)"}}}}},"example":{"isTeamDefault":[false],"name":["string"],"s3Config":[{"accessKey":"string","bucket":"string","endpoint":"string","region":"ny2","retainData":false,"secretAccessKey":"string","signatureVersion":"string"}]}}}}},"get":{"tags":["Storage"],"parameters":[{"name":"id","in":"path","description":"The ID of the storage provider","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/storage/#storageProviders-get","api_endpoint":"https://api.paperspace.com/v1/storage-providers/{id}"},"summary":"Get a storage provider","description":"Get a storage provider | Get a storage provider | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"delete":{"tags":["Storage"],"parameters":[{"name":"id","in":"path","description":"The ID of the storage provider","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/storage/#storageProviders-delete","api_endpoint":"https://api.paperspace.com/v1/storage-providers/{id}"},"summary":"Delete a storage provider","description":"Delete a storage provider | Delete a storage provider | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/storage-providers/utilization":{"get":{"tags":["Storage"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/storage/#storageUtilization-getPublic","api_endpoint":"https://api.paperspace.com/v1/storage-providers/utilization"},"summary":"Get storage utilization","description":"Get storage utilization | Get a breakdown of how storage is being used by your team | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/teams/{teamId}/users":{"get":{"tags":["Teams"],"parameters":[{"name":"teamId","in":"path","description":"The team's ID","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtConfirmed"]}}},{"name":"role","in":"query","description":"Filter team members by their role on the team.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["member","admin","owner"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/teams/#teamMemberships-listByTeamId","api_endpoint":"https://api.paperspace.com/v1/teams/{teamId}/users"},"summary":"List team members","description":"List team members | List team members | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]}},"/teams/{teamId}/users/{userId}":{"put":{"tags":["Teams"],"parameters":[{"name":"teamId","in":"path","description":"The team's ID","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"The user's ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/teams/#teamMemberships-update","api_endpoint":"https://api.paperspace.com/v1/teams/{teamId}/users/{userId}"},"summary":"Update a team membership","description":"Update a team membership | Update a team membership | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"isAdmin":{"type":"boolean","description":"Whether the user will gain admin access or not","required":true,"enum":[true,false]}}},"example":{"isAdmin":[false]}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"teamId","in":"path","description":"The team's ID","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"The user's ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/teams/#teamMemberships-removeUser","api_endpoint":"https://api.paperspace.com/v1/teams/{teamId}/users/{userId}"},"summary":"Remove a user from a team","description":"Remove a user from a team | Remove a user from a team | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/teams/{id}/secrets":{"get":{"tags":["Teams"],"parameters":[{"name":"id","in":"path","description":"The ID of the team where the secret is stored.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Fetch the next page of results after this cursor.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to fetch after this page.","required":false,"schema":{"type":"number","example":""}},{"name":"order","in":"query","description":"The order to sort the results by.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"orderBy","in":"query","description":"Order results by one of these fields.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dtCreated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/teams/#teamSecrets-list","api_endpoint":"https://api.paperspace.com/v1/teams/{id}/secrets"},"summary":"List a team's secrets","description":"List a team's secrets | Fetches a list of secrets for a team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Teams"],"parameters":[{"name":"id","in":"path","description":"The ID of the team where the secret is stored.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/teams/#teamSecrets-create","api_endpoint":"https://api.paperspace.com/v1/teams/{id}/secrets"},"summary":"Create a team secret","description":"Create a team secret | Creates a new secret for a team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the secret, e.g. \"DB_PASSWORD\".","required":true},"value":{"type":"string","description":"The value of the secret, e.g. \"password\".","required":true}}},"example":{"name":["string"],"value":["string"]}}}}}},"/teams/{id}/secrets/{name}":{"get":{"tags":["Teams"],"parameters":[{"name":"id","in":"path","description":"The ID of the team where the secret is stored.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"The name of the secret, e.g. \"DB_PASSWORD\".","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/teams/#teamSecrets-get","api_endpoint":"https://api.paperspace.com/v1/teams/{id}/secrets/{name}"},"summary":"Get a team secret","description":"Get a team secret | Fetches a secret for a team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}]},"patch":{"tags":["Teams"],"parameters":[{"name":"id","in":"path","description":"The ID of the team where the secret is stored.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"The name of the secret, e.g. \"DB_PASSWORD\".","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/teams/#teamSecrets-update","api_endpoint":"https://api.paperspace.com/v1/teams/{id}/secrets/{name}"},"summary":"Update a team secret","description":"Update a team secret | Update the value of a secret for a team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"value":{"type":"string","description":"The value of the secret, e.g. \"password\".","required":true}}},"example":{"value":["string"]}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"id","in":"path","description":"The ID of the team where the secret is stored.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"The name of the secret, e.g. \"DB_PASSWORD\".","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/paperspace/api-reference/teams/#teamSecrets-delete","api_endpoint":"https://api.paperspace.com/v1/teams/{id}/secrets/{name}"},"summary":"Delete a team secret","description":"Delete a team secret | Deletes a secret for a team. | Source: official OpenAPI spec at https://api.paperspace.com/v1/openapi.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}