File Manager - API Reference

All Services byoc mlflow rag_input

BYOC File Management API (1.0.0)

Download OpenAPI specification:

BYOC (Bring Your Own Container) file management endpoints. Handles upload and management of code files for container deployments. Files support versioning (name + version).

BYOC Files

Upload a BYOC file

Uploads a code file for BYOC deployment. Stores the file in StorageSidecar and creates metadata in MetadataStoreSidecar.

Request Body schema: multipart/form-data
required
name
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9][a-zA-Z0-9-_]*$

Service name identifier

version
required
string [ 1 .. 50 ] characters ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0...

Service version identifier (e.g., "1.0.0")

language
required
string (ProgrammingLanguage)
Enum: "python" "nodejs"

Supported programming languages for BYOC

type
required
string (ByocType)
Enum: "Service" "Job"

Type of BYOC deployment

file
required
string <binary>

File content to upload

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "version": "string",
  • "status": "uploaded",
  • "uploaded_at": "2019-08-24T14:15:22Z"
}

List BYOC services

Lists all BYOC services, optionally filtered by name or language.

query Parameters
name
string

Filter by service name

language
string (ProgrammingLanguage)
Enum: "python" "nodejs"

Filter by programming language

limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of results

offset
integer >= 0
Default: 0

Pagination offset

Responses

Response samples

Content type
application/json
{
  • "services": [
    • {
      • "name": "string",
      • "version": "string",
      • "language": "python",
      • "type": "Service",
      • "file_name": "string",
      • "uploaded_at": "2019-08-24T14:15:22Z",
      • "storage_location": "string",
      • "size": 0,
      • "safe_to_delete": false
      }
    ],
  • "total": 0,
  • "limit": 1,
  • "offset": 0
}

List versions of a BYOC service

Lists all available versions of a specific BYOC service.

path Parameters
name
required
string

Service name identifier

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of results

offset
integer >= 0
Default: 0

Pagination offset

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "versions": [
    • {
      • "version": "string",
      • "language": "python",
      • "type": "Service",
      • "size": 0,
      • "uploaded_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "total": 0,
  • "limit": 1,
  • "offset": 0
}

Get BYOC file information

Retrieves metadata and information about a stored BYOC service.

path Parameters
name
required
string

Service name identifier

version
required
string

Service version identifier

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "version": "string",
  • "language": "python",
  • "type": "Service",
  • "file_name": "string",
  • "storage_location": "string",
  • "size": 0,
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "safe_to_delete": false
}

Delete a BYOC file

Deletes a BYOC service file from StorageSidecar and removes its metadata from MetadataStoreSidecar.

path Parameters
name
required
string

Service name identifier

version
required
string

Service version identifier

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "version": "string",
  • "status": "deleted"
}

Download a BYOC file

Downloads the actual file content as a streaming binary response.

path Parameters
name
required
string

Service name identifier

version
required
string

Service version identifier

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}