Create or update package
curl --request POST \
--url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'package={
"name": "<string>",
"latestVersion": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"replicationCount": 1,
"resourceIdentifier": "<string>"
}' \
--form 'version={
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}' \
--form packageFile='@example-file' \
--form 'md5Hash=<string>'import requests
url = "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}"
files = { "packageFile": ("example-file", open("example-file", "rb")) }
payload = {
"package": "{
\"name\": \"<string>\",
\"latestVersion\": \"<string>\",
\"description\": \"<string>\",
\"createdAt\": \"2023-11-07T05:31:56Z\",
\"updatedAt\": \"2023-11-07T05:31:56Z\",
\"replicationCount\": 1,
\"resourceIdentifier\": \"<string>\"
}",
"version": "{
\"id\": \"<string>\",
\"createdAt\": \"2023-11-07T05:31:56Z\",
\"updatedAt\": \"2023-11-07T05:31:56Z\"
}",
"md5Hash": "<string>"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('package', '{
"name": "<string>",
"latestVersion": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"replicationCount": 1,
"resourceIdentifier": "<string>"
}');
form.append('version', '{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}');
form.append('packageFile', '<string>');
form.append('md5Hash', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}', 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://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"package\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"latestVersion\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\r\n \"replicationCount\": 1,\r\n \"resourceIdentifier\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n{\r\n \"id\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packageFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"md5Hash\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"package\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"latestVersion\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\r\n \"replicationCount\": 1,\r\n \"resourceIdentifier\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n{\r\n \"id\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packageFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"md5Hash\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"package\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"latestVersion\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\r\n \"replicationCount\": 1,\r\n \"resourceIdentifier\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n{\r\n \"id\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packageFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"md5Hash\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"package\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"latestVersion\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\r\n \"replicationCount\": 1,\r\n \"resourceIdentifier\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n{\r\n \"id\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packageFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"md5Hash\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"latestVersion": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"replicationCount": 1,
"resourceIdentifier": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}packages
Create or update package
Creates a new package or updates an existing one with a new version. This endpoint handles both package metadata and file uploads for package content.
Authorization: Requires package admin or modeler permissions. Content: Accepts multipart form data with package metadata and binary file content. Validation: Validates package structure and file integrity using MD5 hash.
POST
/
organizations
/
{organizationName}
/
projects
/
{projectName}
/
packages
/
{packageName}
Create or update package
curl --request POST \
--url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'package={
"name": "<string>",
"latestVersion": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"replicationCount": 1,
"resourceIdentifier": "<string>"
}' \
--form 'version={
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}' \
--form packageFile='@example-file' \
--form 'md5Hash=<string>'import requests
url = "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}"
files = { "packageFile": ("example-file", open("example-file", "rb")) }
payload = {
"package": "{
\"name\": \"<string>\",
\"latestVersion\": \"<string>\",
\"description\": \"<string>\",
\"createdAt\": \"2023-11-07T05:31:56Z\",
\"updatedAt\": \"2023-11-07T05:31:56Z\",
\"replicationCount\": 1,
\"resourceIdentifier\": \"<string>\"
}",
"version": "{
\"id\": \"<string>\",
\"createdAt\": \"2023-11-07T05:31:56Z\",
\"updatedAt\": \"2023-11-07T05:31:56Z\"
}",
"md5Hash": "<string>"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('package', '{
"name": "<string>",
"latestVersion": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"replicationCount": 1,
"resourceIdentifier": "<string>"
}');
form.append('version', '{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}');
form.append('packageFile', '<string>');
form.append('md5Hash', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}', 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://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"package\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"latestVersion\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\r\n \"replicationCount\": 1,\r\n \"resourceIdentifier\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n{\r\n \"id\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packageFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"md5Hash\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"package\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"latestVersion\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\r\n \"replicationCount\": 1,\r\n \"resourceIdentifier\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n{\r\n \"id\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packageFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"md5Hash\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"package\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"latestVersion\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\r\n \"replicationCount\": 1,\r\n \"resourceIdentifier\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n{\r\n \"id\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packageFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"md5Hash\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"package\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"latestVersion\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\r\n \"replicationCount\": 1,\r\n \"resourceIdentifier\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n{\r\n \"id\": \"<string>\",\r\n \"createdAt\": \"2023-11-07T05:31:56Z\",\r\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packageFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"md5Hash\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"latestVersion": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"replicationCount": 1,
"resourceIdentifier": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the organization Standard identifier pattern for resource names
Pattern:
^[a-zA-Z0-9_-]+$The unique identifier of the project Standard identifier pattern for resource names
Pattern:
^[a-zA-Z0-9_-]+$The unique identifier of the package Standard identifier pattern for resource names
Pattern:
^[a-zA-Z0-9_-]+$Body
multipart/form-data
Response
Package created successfully
Represents a Malloy data model package containing models, queries, and related resources
The unique name of the package within its project
Pattern:
^[a-zA-Z0-9_-]+$The version identifier of the most recent published version
Pattern:
^[0-9]+\.[0-9]+\.[0-9]+$Human-readable description of the package's purpose and contents
ISO 8601 timestamp indicating when the package was first created
ISO 8601 timestamp indicating when the package was last modified
Number of replicas for high availability and performance
Required range:
1 <= x <= 10Unique resource identifier for the package, used for API references and permissions
Pattern:
^[a-zA-Z0-9_/.:-]+$Status of the indexing process. Possible values: unknown (initial state, indexing not yet started), indexing (currently being processed), indexed (successfully indexed and ready for use), failed (indexing process encountered an error)
Available options:
unknown, indexing, indexed, failed Was this page helpful?
⌘I