The Release Object

This is an object representing a release inside Storyblok.

Properties

• name string

  Name of the release

• id number

  Numeric ID of a release

• release_at string

  Date to deploy the release (Format: YYYY-mm-dd HH:MM)

• released boolean

  True if the release is released

• uuid string

  Unique ID of the release

• timezone string

  Timezone of the release

• branches_to_deploy number[]

  An array of branches (pipeline stages) to deploy the release to

• created_at string

  Date and time the release was created (Format: YYYY-mm-dd HH:MM)

• owner_id number

  Numeric ID of the release owner

• users_to_notify_ids number[]

  An array of user IDs who should be notified of the release

• public boolean

  The access level of the release: Public or Restricted. The default value is true (public). Only the release owner or the space owner can modify this field.

• allowed_user_ids number[]

  An array of user IDs who are allowed to access and interact with the release. Only the release owner or the space owner can modify this field.

• allowed_space_role_ids number[]

  An array of space role IDs that are allowed to access and interact with the release. Only the release owner or the space owner can modify this field.

• allowed_api_key_ids number[]

  To associate an access token with a release, the token access type must be release. Only the release owner or the space owner can modify this field.

Example Response

{
"release": {
  "name": "A Winter Special Release",
  "id": 123212,
  "release_at": null,
  "released": false,
  "uuid": "f4ea2f30-4645-4164-9826-3860215f0caq",
  "timezone": "America/Bahia",
  "branches_to_deploy": [
    32324
  ],
  "created_at": "2023-08-23T11:57:15.188Z",
  "owner_id": 444444,
  "users_to_notify_ids": [
    "444444"
  ],
  "public": false,
  "allowed_user_ids": [
    444444
  ],
  "allowed_space_role_ids": [
    12345678901234
  ],
  "allowed_api_key_ids": [
    12345678904321
  ]
}
}