Skip to main content
POST
/
bundles
cURL
curl --request POST \
  --url https://api.opal.dev/v1/bundles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Engineering Team Bundle",
  "description": "Engineering team bundle.",
  "admin_owner_id": "7870617d-e72a-47f5-a84c-693817ab4567"
}'
{
  "bundle_id": "a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
  "name": "Bundle 1",
  "description": "Description of bundle 1",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "admin_owner_id": "4aed3e8a-727b-4d72-8010-3b8710c50bec",
  "total_num_items": 15,
  "total_num_resources": 10,
  "total_num_groups": 5
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

CreateBundleInfo Object

Description

The CreateBundleInfo object is used to store creation info for a bundle.

Usage Example

Use in the POST Bundles endpoint.

​
name
string
required

The name of the bundle.

Example:

"Test Bundle"

​
admin_owner_id
string
required

The ID of the bundle's admin owner.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

​
description
string

A brief description of the bundle.

Example:

"This is a test bundle"

Response

201 - application/json

The bundle successfully created.

​
bundle_id
string<uuid>

The ID of the bundle.

Example:

"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1"

​
name
string

The name of the bundle.

Example:

"Bundle 1"

​
description
string

The description of the bundle.

Example:

"Description of bundle 1"

​
created_at
string<date-time>

The creation timestamp of the bundle, in ISO 8601 format

​
updated_at
string<date-time>

The last updated timestamp of the bundle, in ISO 8601 format

​
admin_owner_id
string<uuid>

The ID of the owner of the bundle.

Example:

"4aed3e8a-727b-4d72-8010-3b8710c50bec"

​
total_num_items
integer

The total number of items in the bundle.

Example:

15

​
total_num_resources
integer

The total number of resources in the bundle.

Example:

10

​
total_num_groups
integer

The total number of groups in the bundle.

Example:

5