Skip to main content

Apply the current DRAFT revision (promotes to ACTIVE)

POST 

/api/v1/get_config/:configIdentifier/config/revisions/apply

Promotes the current DRAFT revision to ACTIVE, making it the effective config for the project.

Request​

Path Parameters

    configIdentifier stringrequired

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

Body

required

    appliedBy string

    Who is applying (email / user id)

Responses​

Schema

    id numberrequired
    projectId numberrequired
    revisionNumber numberrequired
    status stringrequired

    Possible values: [draft, active, archived]

    appliedBy object
    appliedAt object
    semVer object

    Semantic version (e.g. "1.2.0") assigned when the revision was promoted to ACTIVE. Null for draft revisions.

    createdAt date-timerequired

    groups

    object[]

  • Array [

  • id numberrequired
    name stringrequired
    displayName object

    Optional human-readable display name. Falls back to name when not set.

    isGlobal booleanrequired
    gitFilePath object
    sensitiveKeys string[]required

    Dot-notation key paths whose values are sensitive (e.g. ["password", "credentials.token"]). Values at these paths are masked as *** in API responses.

    yamlContent object

    The group configuration as a complete YAML string. Values at sensitiveKeys paths are masked as ***.

  • ]

  • files

    object[]

    Binary files attached to this revision

  • Array [

  • id numberrequired
    revisionId numberrequired
    group object

    Associated group name, or null

    fileName stringrequired
    size object

    File size in bytes

    sha256 object

    SHA-256 hex digest of the content

    status stringrequired

    Upload status of the backing file (pending until the client finishes the upload)

    position numberrequired
  • ]

Loading...