Skip to main content

Get a presigned URL to upload a binary config file into the DRAFT revision

POST 
/api/v1/get_config/:configIdentifier/config/files/upload-url

Creates (or replaces) a binary file in the current DRAFT revision and returns a presigned PUT URL. Upload the bytes to that URL; the server finalizes the file automatically once object storage reports the upload (size and SHA-256 are recorded). Set applyAfterUpload: true to apply the revision automatically once the upload is finalized, or leave it false to stage several files and apply them together later via revisions/apply. Optionally associate the file with a group via group.

Request​

Path Parameters

    configIdentifier stringrequired

    Config project ID or name, or a device ID (resolved to its config: project)

Body

required

    fileName stringrequired

    File name (used as the delivery item key suffix and storage object name)

    group string

    Optional config group to associate this file with. A group may hold multiple files.

    contentType string

    Content type of the file (defaults to application/octet-stream).

    applyAfterUpload boolean

    Default value: false

    When true, the DRAFT revision is applied automatically once this file finishes uploading (the client must call the complete endpoint after the upload). Set false to stage several files and apply them together later via the apply endpoint.

Responses​

Schema

    configFileId numberrequired

    ID of the config file row created/updated in the draft revision

    fileUploadId numberrequired

    ID of the backing file_upload row

    url stringrequired

    Presigned PUT URL to upload the file bytes directly to object storage

    objectKey stringrequired

    Object storage key the file is uploaded to

Loading...