Skip to main content
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>",
  "indexStatus": "unknown"
}' \
  --form 'version={
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "archiveStatus": "archive",
  "indexStatus": "unknown"
}' \
  --form packageFile='@example-file' \
  --form 'md5Hash=<string>'
{
  "name": "<string>",
  "latestVersion": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "replicationCount": 1,
  "resourceIdentifier": "<string>",
  "indexStatus": "unknown"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
projectName
string
required

The unique identifier of the project Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
packageName
string
required

The unique identifier of the package Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$

Body

multipart/form-data
​
package
object

Represents a Malloy data model package containing models, queries, and related resources

​
version
object

Represents a specific version of a package with metadata and lifecycle information

​
packageFile
file
​
md5Hash
string

Response

Package created successfully

Represents a Malloy data model package containing models, queries, and related resources

​
name
string

The unique name of the package within its project

Pattern: ^[a-zA-Z0-9_-]+$
​
latestVersion
string

The version identifier of the most recent published version

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$
​
description
string

Human-readable description of the package's purpose and contents

​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the package was first created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the package was last modified

​
replicationCount
integer
default:1

Number of replicas for high availability and performance

Required range: 1 <= x <= 10
​
resourceIdentifier
string

Unique resource identifier for the package, used for API references and permissions

Pattern: ^[a-zA-Z0-9_/.:-]+$
​
indexStatus
enum<string>

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