Share a container image

Shares a container image with another workspace by copying the metadata record. The underlying storage (S3) data is not duplicated. For same-account targets the share is applied immediately. For cross-account targets, a pending image share is created and must be explicitly accepted by an admin of the target workspace; the correct target account ID must be supplied as an anti-spam measure.

POST /images/{resourceType}/{imageName}/share

Share a container image

cURL

curl --request POST \
  --url https://api.blaxel.ai/v0/images/{resourceType}/{imageName}/share \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetWorkspace": "<string>",
  "targetAccountId": "<string>"
}
'

import requests

url = "https://api.blaxel.ai/v0/images/{resourceType}/{imageName}/share"

payload = {
    "targetWorkspace": "<string>",
    "targetAccountId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({targetWorkspace: '<string>', targetAccountId: '<string>'})
};

fetch('https://api.blaxel.ai/v0/images/{resourceType}/{imageName}/share', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blaxel.ai/v0/images/{resourceType}/{imageName}/share",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'targetWorkspace' => '<string>',
    'targetAccountId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blaxel.ai/v0/images/{resourceType}/{imageName}/share"

	payload := strings.NewReader("{\n  \"targetWorkspace\": \"<string>\",\n  \"targetAccountId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.blaxel.ai/v0/images/{resourceType}/{imageName}/share")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"targetWorkspace\": \"<string>\",\n  \"targetAccountId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blaxel.ai/v0/images/{resourceType}/{imageName}/share")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"targetWorkspace\": \"<string>\",\n  \"targetAccountId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "metadata": {
    "createdAt": "<string>",
    "displayName": "<string>",
    "events": [
      {
        "canaryRevision": "<string>",
        "message": "Deployment successful",
        "revision": "rev-abc123",
        "status": "DEPLOYED",
        "time": "2025-01-15T10:30:00Z",
        "type": "deployment"
      }
    ],
    "lastDeployedAt": "<string>",
    "name": "<string>",
    "resourceType": "<string>",
    "sourceWorkspace": "<string>",
    "updatedAt": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "size": 123,
    "tags": [
      {
        "createdAt": "<string>",
        "name": "<string>",
        "size": 123,
        "updatedAt": "<string>"
      }
    ]
  }
}

{
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "expiresAt": "<string>",
  "id": "<string>",
  "imageName": "<string>",
  "resourceType": "<string>",
  "sharedBy": "<string>",
  "sourceAccountId": "<string>",
  "sourceWorkspace": "<string>",
  "targetAccountId": "<string>",
  "targetWorkspace": "<string>"
}

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Path Parameters

resourceType · string · required

Resource type (agents, functions, sandboxes, jobs)

imageName · string · required

Name of the container image repository

Body

application/json

targetWorkspace · string · required

Name of the workspace to share the image with

targetAccountId · string

Account ID of the target workspace. Required when the target workspace belongs to a different account than the source workspace (anti-spam).

Response

200

application/json

successful operation (same-account share, applied immediately)

metadata · object · required

Show child attributes

spec · object · required

Show child attributes