Lambda Filesystems API
The Filesystems API from Lambda — 3 operation(s) for filesystems.
OpenAPI Specification
openapi: 3.1.0
info:
title: Lambda Cloud Audit Events Filesystems API
version: 1.10.0
description: "The Lambda Cloud API provides a set of REST API endpoints you can use to create\nand manage your Lambda Cloud resources.\n\nRequests to the API are generally limited to one request per second. Requests to\nthe `/instance-operations/launch` endpoint are limited to one request per 12\nseconds, or five requests per minute.\n\n## Response types and formats {#formats}\n\nThe format of each response object depends on whether the request succeeded or failed.\n\n### Success responses {#success-responses}\n\nWhen a request succeeds, the API returns a response object in the following format. `<PAYLOAD>`\nrepresents the endpoint-specific data object returned as part of the response object.\n\n```json\n{\n \"data\": <PAYLOAD>\n}\n```\n\n### Error responses {#error-responses}\n\nWhen a request fails, the API returns an error response object in the following format:\n\n```json\n{\n \"error\": {\n \"code\": string,\n \"message\": string,\n \"suggestion\": string?\n }\n}\n```\n\n- `code`: A machine- and human-readable error code specific to a particular failure mode.\n- `message`: An explanation of the error.\n- `suggestion`: When present, a suggestion for how to address the error.\n\n:::note{type=\"info\" title=\"Note\"}\nWhen handling errors, avoid relying on the values of `message` or `suggestion`, as\nthese values are subject to change. Instead, use the value of `code`.\n:::\n\n#### Provider errors {#provider-errors}\n\nIn some cases, you might receive errors that come from upstream services/providers rather than directly\nfrom Lambda services. You can identify these errors by their error code prefix, `provider/`.\n\nCommon provider errors include:\n\n- Network outages or connectivity issues\n- Service unavailability\n- Quota limitations or resource exhaustion\n\nAn example of a typical service unavailability error:\n\n```json\n{\n \"error\": {\n \"code\": \"provider/internal-unavailable\",\n \"message\": \"Provider unavailable\",\n \"suggestion\": \"Try again shortly\"\n }\n}\n```\n## Outgoing webhooks {#outgoing-webhooks}\n\nLambda can send webhook notifications to your URL when support ticket events occur,\nenabling near real-time integration with your systems.\n\n### Event types {#event-types}\n\n- `ticket.created` - A support ticket was created.\n- `ticket.status_changed` - A support ticket's status was updated, and the ticket remains open.\n- `ticket.resolved` - A support ticket's status was set to `solved`, or the ticket was closed.\n\n### Payload structure {#payload-structure}\n\nAll webhook payloads follow this structure:\n\n```json\n{\n \"id\": \"a3b7c9d1e5f642a8b0c2d4e6f8a0b2c4\",\n \"object\": \"event\",\n \"type\": \"ticket.created\",\n \"created\": 1700000000,\n \"api_version\": \"2025-11-18\",\n \"data\": {\n \"object\": \"ticket\",\n \"id\": \"f1e2d3c4b5a647869708192a3b4c5d6e\",\n \"subject\": \"Issue with instance 0920582c7ff041399e34823a0be62549\",\n \"description\": \"Detailed description of the issue...\",\n \"request_type\": \"incident\",\n \"severity\": \"sev_2\",\n \"status\": \"new\",\n \"created_at\": \"2024-11-15T10:00:00+00:00\",\n \"updated_at\": \"2024-11-15T10:00:00+00:00\",\n \"instance_ip\": \"192.168.1.100\",\n \"instance_id\": \"0920582c7ff041399e34823a0be62549\",\n \"cluster_id\": null,\n \"source\": \"api\"\n }\n}\n```\n\n### Webhook authentication {#webhook-authentication}\n\nWebhook requests include a Bearer token in the `Authorization` header for authentication:\n\n```http\nAuthorization: Bearer <token>\n```\n## Authentication {#authentication}\n\nThe Lambda Cloud API uses API keys to authenticate incoming requests. You\ncan generate a new API key pair or view your existing API keys by visiting\nthe [API keys page](https://cloud.lambda.ai/api-keys) in the Lambda Cloud\ndashboard.\n\nIn general, Lambda recommends passing an HTTP Bearer header that contains\nyour API key:\n\n```http\nAuthorization: Bearer <YOUR-API-KEY>\n```\n\n### Authenticating with `curl` {#authenticating-with-curl}\n\nThe API also supports passing an HTTP Basic header. This option chiefly exists\nto support `curl`'s `-u` flag, which allows you to pass your credentials\nwithout having to write out the full `Authorization: Basic` header string.\nFor example:\n\n```bash\ncurl --request GET --url 'https://cloud.lambda.ai/api/v1/instances' \\\n --header 'accept: application/json' \\\n --user '<YOUR-API-KEY>:'\n```\n\nIf your use case requires it, you can also pass the HTTP Basic header directly.\nThe value you pass must be a Base64-encoded string containing your API key\nand a trailing colon:\n\n```http\nAuthorization: Basic <BASE64-ENCODED-API-KEY>:\n```\n\n:::note{type=\"attention\" title=\"Important\"}\nIf you make a request without including a supported `Authorization` header,\nthe request will fail.\n:::"
servers:
- url: https://cloud.lambda.ai/
description: Production server
- url: https://cloud.lambdalabs.com/
description: Secondary production server (deprecated)
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Filesystems
paths:
/api/v1/file-systems:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
additionalProperties: false
properties:
data:
type: array
items:
$ref: '#/components/schemas/Filesystem'
required:
- data
type: object
'400':
description: Bad Request
content:
application/json:
schema:
additionalProperties: false
properties:
error:
$ref: '#/components/schemas/ApiErrorInvalidParameters'
required:
- error
type: object
'401':
description: Unauthorized
content:
application/json:
schema:
additionalProperties: false
properties:
error:
$ref: '#/components/schemas/ApiErrorUnauthorized'
required:
- error
type: object
'403':
description: Forbidden
content:
application/json:
schema:
additionalProperties: false
properties:
error:
$ref: '#/components/schemas/ApiErrorAccountInactive'
required:
- error
type: object
'404':
description: Not Found
content:
application/json:
schema:
additionalProperties: false
properties:
error:
$ref: '#/components/schemas/ApiErrorNotFound'
required:
- error
type: object
tags:
- Filesystems
summary: List filesystems
description: Retrieves a list of your filesystems.
operationId: listFilesystems
/api/v1/filesystems:
post:
responses:
'200':
description: OK
content:
application/json:
schema:
additionalProperties: false
properties:
data:
$ref: '#/components/schemas/Filesystem'
required:
- data
type: object
'400':
description: Bad Request
content:
application/json:
schema:
additionalProperties: false
properties:
error:
anyOf:
- $ref: '#/components/schemas/ApiErrorDuplicate'
- $ref: '#/components/schemas/ApiErrorQuotaExceeded'
- $ref: '#/components/schemas/ApiErrorInvalidParameters'
required:
- error
type: object
'401':
description: Unauthorized
content:
application/json:
schema:
additionalProperties: false
properties:
error:
$ref: '#/components/schemas/ApiErrorUnauthorized'
required:
- error
type: object
'403':
description: Forbidden
content:
application/json:
schema:
additionalProperties: false
properties:
error:
anyOf:
- $ref: '#/components/schemas/ApiErrorAccountInactive'
- $ref: '#/components/schemas/ApiErrorInvalidBillingAddress'
required:
- error
type: object
'404':
description: Not Found
content:
application/json:
schema:
additionalProperties: false
properties:
error:
$ref: '#/components/schemas/ApiErrorNotFound'
required:
- error
type: object
tags:
- Filesystems
summary: Create filesystem
description: Creates a new filesystem.
operationId: createFilesystem
requestBody:
content:
application/json:
schema:
properties:
name:
type: string
minLength: 1
maxLength: 60
pattern: ^[a-zA-Z]+[0-9a-zA-Z-]*$
description: The name of the filesystem.
examples:
- my-filesystem
region:
type: string
description: The region in which you want to create the filesystem.
examples:
- us-west-1
required:
- name
- region
title: FilesystemCreateRequest
type: object
required: true
/api/v1/filesystems/{id}:
delete:
responses:
'200':
description: OK
content:
application/json:
schema:
additionalProperties: false
properties:
data:
$ref: '#/components/schemas/FilesystemDeleteResponse'
required:
- data
type: object
'400':
description: Bad Request
content:
application/json:
schema:
additionalProperties: false
properties:
error:
anyOf:
- $ref: '#/components/schemas/ApiErrorFilesystemInUse'
- $ref: '#/components/schemas/ApiErrorInvalidParameters'
required:
- error
type: object
'401':
description: Unauthorized
content:
application/json:
schema:
additionalProperties: false
properties:
error:
$ref: '#/components/schemas/ApiErrorUnauthorized'
required:
- error
type: object
'403':
description: Forbidden
content:
application/json:
schema:
additionalProperties: false
properties:
error:
$ref: '#/components/schemas/ApiErrorAccountInactive'
required:
- error
type: object
'404':
description: Not Found
content:
application/json:
schema:
additionalProperties: false
properties:
error:
$ref: '#/components/schemas/ApiErrorFilesystemNotFound'
required:
- error
type: object
tags:
- Filesystems
summary: Delete filesystem
description: Deletes the filesystem with the specified ID. The filesystem must not be mounted to any running instances at the time of deletion.
operationId: filesystemDelete
parameters:
- name: id
in: path
description: The unique identifier (ID) of the filesystem to delete
required: true
schema:
description: The unique identifier (ID) of the filesystem to delete
example: 398578a2336b49079e74043f0bd2cfe8
type: string
example: 398578a2336b49079e74043f0bd2cfe8
components:
schemas:
User:
type: object
properties:
id:
type: string
description: The unique identifier for the user.
examples:
- 3da5a70a57a7422ea8a7203f98b2198b
email:
type: string
description: The email address of the user.
examples:
- me@example.com
status:
$ref: '#/components/schemas/UserStatus'
description: The status of the user's account.
required:
- id
- email
- status
title: User
description: Information about a user in your Team.
Region:
type: object
properties:
name:
type: string
description: The region code.
description:
type: string
description: The region description.
required:
- name
- description
title: Region
UserStatus:
title: UserStatus
description: Status of the user's account.
enum:
- active
- deactivated
type: string
ApiErrorInvalidBillingAddress:
type: object
properties:
code:
const: global/invalid-address
type: string
description: The unique identifier for the type of error.
message:
type: string
default: Your billing address is invalid.
description: A description of the error.
suggestion:
type: string
default: Make sure your billing address is valid. Contact Support if problems continue.
description: One or more suggestions of possible ways to fix the error.
required:
- code
- message
- suggestion
title: ApiErrorInvalidBillingAddress
FilesystemDeleteResponse:
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: The unique identifiers of the filesystems that were deleted.
examples:
- - 398578a2336b49079e74043f0bd2cfe8
required:
- deleted_ids
title: FilesystemDeleteResponse
ApiErrorFilesystemNotFound:
type: object
properties:
code:
const: global/object-does-not-exist
type: string
description: The unique identifier for the type of error.
message:
type: string
default: Filesystem was not found.
description: A description of the error.
suggestion:
type: string
description: One or more suggestions of possible ways to fix the error.
required:
- code
- message
title: ApiErrorFilesystemNotFound
ApiErrorFilesystemInUse:
type: object
properties:
code:
const: filesystems/filesystem-in-use
type: string
description: The unique identifier for the type of error.
message:
type: string
description: A description of the error.
suggestion:
type: string
description: One or more suggestions of possible ways to fix the error.
required:
- code
- message
title: ApiErrorFilesystemInUse
ApiErrorNotFound:
type: object
properties:
code:
const: global/not-found
type: string
description: The unique identifier for the type of error.
message:
type: string
default: The requested resource was not found.
description: A description of the error.
suggestion:
type: string
description: One or more suggestions of possible ways to fix the error.
required:
- code
- message
title: ApiErrorNotFound
ApiErrorDuplicate:
type: object
properties:
code:
const: global/duplicate
type: string
description: The unique identifier for the type of error.
message:
type: string
description: A description of the error.
suggestion:
type: string
description: One or more suggestions of possible ways to fix the error.
required:
- code
- message
title: ApiErrorDuplicate
ApiErrorUnauthorized:
type: object
properties:
code:
const: global/invalid-api-key
type: string
description: The unique identifier for the type of error.
message:
type: string
default: API key was invalid, expired, or deleted.
description: A description of the error.
suggestion:
type: string
default: Check your API key or create a new one, then try again.
description: One or more suggestions of possible ways to fix the error.
required:
- code
- message
- suggestion
title: ApiErrorUnauthorized
ApiErrorAccountInactive:
type: object
properties:
code:
const: global/account-inactive
type: string
description: The unique identifier for the type of error.
message:
type: string
default: Your account is inactive.
description: A description of the error.
suggestion:
type: string
default: Make sure you have verified your email address and have a valid payment method. Contact Support if problems continue.
description: One or more suggestions of possible ways to fix the error.
required:
- code
- message
- suggestion
title: ApiErrorAccountInactive
ApiErrorQuotaExceeded:
type: object
properties:
code:
const: global/quota-exceeded
type: string
description: The unique identifier for the type of error.
message:
type: string
default: Quota exceeded.
description: A description of the error.
suggestion:
type: string
default: Contact Support to increase your quota.
description: One or more suggestions of possible ways to fix the error.
required:
- code
- message
- suggestion
title: ApiErrorQuotaExceeded
ApiErrorInvalidParameters:
type: object
properties:
code:
const: global/invalid-parameters
type: string
description: The unique identifier for the type of error.
message:
type: string
default: Invalid request data.
description: A description of the error.
suggestion:
type: string
description: One or more suggestions of possible ways to fix the error.
required:
- code
- message
title: ApiErrorInvalidParameters
Filesystem:
type: object
properties:
id:
type: string
description: The unique identifier (ID) of the filesystem.
examples:
- 398578a2336b49079e74043f0bd2cfe8
name:
type: string
description: The name of the filesystem.
examples:
- my-filesystem
mount_point:
type: string
description: 'The DEFAULT absolute path indicating where on instances the filesystem will be mounted.
If `file_system_mounts` were used at launch time, the actual mount point is in the
instance response.'
examples:
- /lambda/nfs/my-filesystem
created:
type: string
format: date-time
description: The date and time at which the filesystem was created. Formatted as an ISO 8601 timestamp.
created_by:
$ref: '#/components/schemas/User'
description: The user in your Team that created the filesystem.
is_in_use:
type: boolean
description: 'Whether the filesystem is currently mounted to an instance. Filesystems that
are mounted cannot be deleted.'
region:
$ref: '#/components/schemas/Region'
description: The region in which the filesystem is deployed.
bytes_used:
type: integer
description: 'The approximate amount of storage used by the filesystem in bytes. This estimate is
updated every few hours.'
required:
- id
- name
- mount_point
- created
- created_by
- is_in_use
- region
title: Filesystem
description: Information about a shared filesystem.
securitySchemes:
basicAuth:
type: http
description: 'Basic HTTP authentication. Allowed headers:
* `Authorization: Basic <base64 encoding of api_key>:`
* `Authorization: Basic <api_key>`'
scheme: basic
bearerAuth:
type: http
description: 'Bearer HTTP authentication. Allowed headers:
* `Authorization: Bearer <api_key>`'
scheme: bearer
x-lambda-api-keys-config-url: https://cloud.lambda.ai/api-keys