Skip to main content
PATCH
/
bundles
/
{id}
Update bundle by ID
curl --request PATCH \
  --url https://mycluster.domino.tech/bundles/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "policyId": "<string>",
  "stage": "<string>"
}
'
{
  "id": "<string>",
  "attachments": [
    {
      "approvalTimelineMap": {},
      "createdAt": "<string>",
      "createdBy": {},
      "id": "<string>",
      "identifier": {}
    }
  ],
  "classificationValue": "<string>",
  "commentsCount": 123,
  "createdAt": "<string>",
  "createdBy": {},
  "gates": [
    {
      "bundleId": "<string>",
      "id": "<string>",
      "isOpen": true,
      "name": "<string>",
      "policyGateId": "<string>",
      "reason": "<string>",
      "resources": [
        {
          "failOpen": true,
          "parameters": {}
        }
      ]
    }
  ],
  "name": "<string>",
  "policies": [
    {
      "bundleId": "<string>",
      "classificationValue": "<string>",
      "createdAt": "<string>",
      "deactivatedAt": "<string>",
      "enforceSequentialOrder": true,
      "isPolicyArchived": true,
      "policyId": "<string>",
      "policyName": "<string>",
      "policyVersionId": "<string>",
      "stage": "<string>"
    }
  ],
  "policyId": "<string>",
  "policyName": "<string>",
  "policyVersionId": "<string>",
  "projectId": "<string>",
  "projectName": "<string>",
  "projectOwner": "<string>",
  "stage": "<string>",
  "stageApprovals": [
    {
      "approvers": [
        {
          "editable": true,
          "id": "<string>",
          "name": "<string>",
          "showByDefault": true,
          "fromOrganizationUserId": "<string>",
          "isOrganizationUser": true
        }
      ],
      "evidence": {
        "artifacts": [
          {
            "details": {},
            "id": "<string>",
            "required": true,
            "visibilityRule": "<string>",
            "visible": true
          }
        ],
        "createdAt": "<string>",
        "description": "<string>",
        "externalId": "<string>",
        "id": "<string>",
        "name": "<string>",
        "policyId": "<string>",
        "policyVersionId": "<string>",
        "visible": true
      },
      "id": "<string>",
      "name": "<string>",
      "required": true
    }
  ],
  "stageAssignee": {
    "id": "<string>",
    "name": "<string>"
  },
  "stages": [
    {
      "assignedAt": "<string>",
      "assignee": {
        "id": "<string>",
        "name": "<string>"
      },
      "bundleId": "<string>",
      "stage": {
        "approvals": [
          {
            "approvers": [
              {
                "editable": true,
                "id": "<string>",
                "name": "<string>",
                "showByDefault": true,
                "fromOrganizationUserId": "<string>",
                "isOrganizationUser": true
              }
            ],
            "evidence": {
              "artifacts": [
                {
                  "details": {},
                  "id": "<string>",
                  "required": true,
                  "visibilityRule": "<string>",
                  "visible": true
                }
              ],
              "createdAt": "<string>",
              "description": "<string>",
              "externalId": "<string>",
              "id": "<string>",
              "name": "<string>",
              "policyId": "<string>",
              "policyVersionId": "<string>",
              "visible": true
            },
            "id": "<string>",
            "name": "<string>",
            "required": true
          }
        ],
        "evidenceSet": [
          {
            "artifacts": [
              {
                "details": {},
                "id": "<string>",
                "required": true,
                "visibilityRule": "<string>",
                "visible": true
              }
            ],
            "createdAt": "<string>",
            "description": "<string>",
            "externalId": "<string>",
            "id": "<string>",
            "name": "<string>",
            "policyId": "<string>",
            "policyVersionId": "<string>",
            "visible": true
          }
        ],
        "id": "<string>",
        "name": "<string>",
        "policyVersionId": "<string>"
      },
      "stageId": "<string>"
    }
  ]
}

Path Parameters

id
string
required

ID of bundle to update

Body

application/json

Bundle to update

policyId
string

if present, update the primary policy of the bundle

stage
string

if present, update the stage of the bundle's primary policy

state
enum<string>

if present, update the state of the bundle

Available options:
Active,
Archived,
Complete

Response

OK

id
string
required
state
enum<string>
required
Available options:
Active,
Archived,
Complete
attachments
object[]
classificationValue
string

The classification value of the primary policy

commentsCount
integer
createdAt
string
createdBy
object
gates
object[]
name
string
policies
object[]
policyId
string

The ID of the primary policy

policyName
string
policyVersionId
string

The version of the primary policy

projectId
string
projectName
string
projectOwner
string
stage
string

The stage of the primary policy

stageApprovals
object[]
stageAssignee
object

The assignee to the stage of the primary policy

stages
object[]