Upload a file

POST 
/file

Upload a file to the Object Store.

Request

Query Parameters

force boolean

When true, bypass the digest check and always write the file. Returns changed=true regardless of whether the content differs from the existing object.

multipart/form-data

Body

required

The file to upload.

name stringrequired

The name of the file in the Object Store.

content_type string

Possible values: [raw, template]

Default value: raw

How the file should be treated during deploy. "raw" writes bytes as-is; "template" renders with Go text/template and agent facts.

file binaryrequired

The file content.

Responses

201

File uploaded successfully.

application/json

Schema

Schema

name stringrequired

The name of the uploaded file.

sha256 stringrequired

SHA-256 hash of the file content.

size integerrequired

File size in bytes.

changed booleanrequired

Whether the file content changed. False when the Object Store already held an object with the same SHA-256 digest.

content_type stringrequired

How the file should be treated during deploy (raw or template).

Example (from schema)

{
  "name": "nginx.conf",
  "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "size": 1024,
  "changed": true,
  "content_type": "raw"
}

400

Invalid request payload.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

409

File already exists with different content. Use ?force=true to overwrite.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error uploading file.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...