Deploy a file from Object Store to the host

POST 
/node/:hostname/file/deploy

Deploy a file from Object Store to the host

Request

Path Parameters

hostname stringrequired

Possible values: non-empty

Target agent hostname, reserved routing value (_any, _all), or label selector (key:value).

application/json

Body

required

object_name stringrequired

Name of the file in the Object Store.

path stringrequired

Destination path on the target filesystem.

mode string

File permission mode (e.g., "0644").

owner string

File owner user.

group string

File owner group.

content_type stringrequired

Possible values: [raw, template]

Content type — "raw" or "template".

vars

object

Template variables when content_type is "template".

property name* any

Template variables when content_type is "template".

Responses

202

File deploy job accepted.

application/json

Schema

Schema

job_id uuid

The job ID used to process this request.

results

object[]

required

Array [

hostname stringrequired

The agent that processed the job.

status stringrequired

Possible values: [ok, failed, skipped]

The status of the operation for this host.

changed boolean

Whether the file was actually written.

error string

Error message if the agent failed.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "string",
      "status": "ok",
      "changed": true,
      "error": "string"
    }
  ]
}

400

Invalid input.

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.

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.

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

Internal error.

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