Releases

The /releases endpoint provides read-only access to releases. Releases function similarly to branches in a version control system, allowing you to manage different versions of instance metadata within a release group.

See Also

• Authentication — Required for all API requests
• Release Management — Administering releases
• Release Management (Instances) — Working with releases in the instance context
• Release Group — Release group concepts
• Release Groups API — Release group endpoint

GET /api/v1/releases — Find Releases

Retrieve a list of releases, optionally filtered by release group, name, or status.

Endpoint

GET https://app.metakraftwerk.com/api/v1/releases

Query Parameters

Parameter	Type	Required	Description
group	string	No	Filter by release group name.
group_id	integer	No	Filter by release group ID.
name	string	No	Filter by release name.
closed	boolean	No	Filter by closed status (true or false).

Response Schema

Returns an array of release objects:

Field	Type	Description
id	integer	Unique release ID.
group_id	integer	Release group ID.
name	string	Release name.
description	string	Release description.
start_date	string	ISO 8601 start date.
end_date	string	ISO 8601 end date.
closed	boolean	Whether the release is closed.
deleted	boolean	Whether the release is marked as deleted.
hotfix_of_id	integer	ID of the release this is a hotfix of (if applicable).
prev_release_id	integer	ID of the previous release in sequence (if applicable).

Examples

cURL

# List all releases
curl -X GET "https://app.metakraftwerk.com/api/v1/releases" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# Find by release group name
curl -X GET "https://app.metakraftwerk.com/api/v1/releases?group=DWH_GROUP" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# Find open releases
curl -X GET "https://app.metakraftwerk.com/api/v1/releases?closed=false" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# Find by name
curl -X GET "https://app.metakraftwerk.com/api/v1/releases?name=R1" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# Combine filters
curl -X GET "https://app.metakraftwerk.com/api/v1/releases?group=DWH_GROUP&closed=false" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

JavaScript (Fetch)

const response = await fetch(
  'https://app.metakraftwerk.com/api/v1/releases?name=R1',
  { headers: { 'Authorization': `Bearer ${accessToken}` } }
);

const releases = await response.json();

Response Example

[
  {
    "id": 21,
    "group_id": 1,
    "name": "R1",
    "description": "First release",
    "start_date": "2022-01-01T23:00:00.000Z",
    "end_date": "2022-01-07T23:00:00.000Z",
    "closed": false,
    "deleted": false,
    "hotfix_of_id": null,
    "prev_release_id": null
  }
]

Error Responses

Status	Condition	Example Message
401	Missing or invalid token	Not authenticated
404	Release group not found	A release group with the name 'X' does not exist!

---

GET /api/v1/releases/:id — Get Release

Retrieve a single release by its ID.

Endpoint

GET https://app.metakraftwerk.com/api/v1/releases/:id

Path Parameters

Parameter	Type	Required	Description
id	integer	Yes	The release ID.

Examples

cURL

curl -X GET "https://app.metakraftwerk.com/api/v1/releases/21" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

JavaScript (Fetch)

const response = await fetch(
  'https://app.metakraftwerk.com/api/v1/releases/21',
  { headers: { 'Authorization': `Bearer ${accessToken}` } }
);

const release = await response.json();

Error Responses

Status	Condition	Example Message
401	Missing or invalid token	Not authenticated
404	Release not found	No record found for id 'X'

---

POST /api/v1/releases — Create

Not implemented

PUT /api/v1/releases — Update

Not implemented

PATCH /api/v1/releases/:id — Patch

Not implemented

DELETE /api/v1/releases/:id — Remove

Not implemented