Sign in
Publishing

Push bundle to environments

Queues an existing bundle for publishing to specified environments. The bundle must exist and have assets already added. Supports publish, expire, and publishexpire operations with ISO 8601 date/time format.

post/api/v1/publishing/push/{bundleId}

Path parameters

bundleIdstring required

Bundle identifier

Request body

operation'publish' | 'expire' | 'publishexpire' required

Operation type: publish, expire, or publishexpire. Case-insensitive (PUBLISH, Publish, publish all accepted).

publishDatestring date-time

Scheduled publish date in ISO 8601 format with timezone offset (required for publish/publishexpire). Dates without timezone offset are rejected.

expireDatestring date-time

Scheduled expire date in ISO 8601 format with timezone offset (required for expire/publishexpire). Dates without timezone offset are rejected.

environmentsstring[] required

List of environment IDs to push the bundle to

filterKeystring required

Push publishing filter key

Example request

{
  "operation": "publish",
  "publishDate": "2025-03-15T14:30:00-05:00",
  "expireDate": "2025-04-15T14:30:00-05:00",
  "environments": [
    "env-123",
    "env-456"
  ],
  "filterKey": "ForcePush.yml"
}

Response

Bundle successfully queued for publishing

i18nMessagesMapobject
permissionsstring[]

Example response

{
  "entity": {
    "bundleId": "01KJWNJM2C67DM56GHBJ4S7B89",
    "operation": "publish",
    "publishDate": "2025-03-15T14:30:00-05:00",
    "expireDate": "2025-04-15T14:30:00-05:00",
    "filterKey": "ForcePush.yml"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.