TileDB Storage Platform API (v1)
The primary TileDB Cloud REST API. 168 operations across arrays, groups, assets, files, notebooks, UDFs, task graphs, SQL, queries, users, organizations, invitations, favorites and tokens. Published by TileDB as a Swagger 2.0 contract with basePath /v1. Authenticates with an X-TILEDB-REST-API-KEY header, HTTP Basic, or OAuth 2.0 authorization code. Bodies negotiate between application/json and application/capnp (Cap'n Proto) for the high-throughput query paths.
This API exposes 168 operations across 128 paths, organized into 19 resource areas, and defines 187 schemas. It is described by OpenAPI 2.0, at version 2.17.51.
Requests are made against the base URL https://api.tiledb.com/v1.
168 operations
128 paths
187 schemas
20 DELETE78 GET16 PATCH54 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
TileDB Storage Platform API (v1) declares
3 security schemes
for authenticating requests.
It defines a basic scheme (BasicAuth).
An API key is passed in the header as X-TILEDB-REST-API-KEY (ApiKeyAuth).
It supports OAuth 2.0 (OAuth2) using the accessCode flow, exposing 3 scopes.
By default, every request must be authenticated.
Paths & Operations 168
Across 128 paths, the API surfaces 168 operations — 20 DELETE, 78 GET, 16 PATCH, 54 POST. They span 19 resource areas, including stats, array, udf, query, user, organization, tasks, array_tasks, and 11 more. Each is listed below with its method, path, parameters, and response codes.
stats 1
GET
/.stats
Fetch libtiledb stat
array 34
GET
/arrays
get all array metadata user has access to
GET
/arrays/{namespace}
get metadata on all arrays in a namespace
DELETE
/arrays/{namespace}/{array}
delete a array
GET
/arrays/{namespace}/{array}
get an ArraySchema using a url encoded uri
POST
/arrays/{namespace}/{array}
create a array schema at a specified URI registered to a group/project
GET
/arrays/{namespace}/{array}/activity
get array activity logs
GET
/arrays/{namespace}/{array}/activity/{id}
get activity log by ID
DELETE
/arrays/{namespace}/{array}/deregister
deregister a array
GET
/arrays/{namespace}/{array}/array_metadata
get metadata on an array
POST
/arrays/{namespace}/{array}/array_metadata
update metadata on an array
POST
/arrays/{namespace}/{array}/fragment_info
fetch an array's fragment info
GET
/arrays/{namespace}/{array}/metadata
get metadata on an array
PATCH
/arrays/{namespace}/{array}/metadata
update metadata on an array
GET
/arrays/{namespace}/{array}/fragment_end_timestamp
Get fragment endtimestamp on an array, will search for the closest endtimestamp to the timestamp asked
POST
/arrays/{namespace}/{array}/register
register an array at a specified URI registered to the given namespace
POST
/arrays/{namespace}/{array}/consolidate
consolidate an array at a specified URI
POST
/arrays/{namespace}/{array}/vacuum
vacuum an array at a specified URI
POST
/arrays/{namespace}/{array}/enumerations
request to get the enumerations of the arrays' attributes
POST
/arrays/{namespace}/{array}/schema
request to get the array schema
GET
/arrays/{namespace}/{array}/share
Get all sharing details of the array
PATCH
/arrays/{namespace}/{array}/share
Share an array with a user
GET
/arrays/{namespace}/{array}/non_empty_domain
get the non empty domain of an array
GET
/arrays/{namespace}/{array}/max_buffer_sizes
get the max buffer sizes of an array for a subarray
GET
/arrays/{namespace}/{array}/sample
get an sample set of data from the array
GET
/arrays/{namespace}/{array}/metadata_json
get metadata from the array in JSON format
GET
/arrays/{namespace}/{array}/non_empty_domain_json
get non-empty domain from the array in json format
GET
/arrays/{namespace}/{array}/end_timestamps
retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
GET
/arrays/last_accessed
GET
/arrays/browser/shared
Fetch a list of all arrays that have been shared with the user
GET
/arrays/browser/shared/sidebar
Fetch a list of all arrays that have been shared with the user
GET
/arrays/browser/public
Fetch a list of all arrays that have been shared publically
GET
/arrays/browser/public/sidebar
Fetch a sidebar of all arrays that have been shared publically
GET
/arrays/browser/owned
Fetch a list of all arrays that are owned directly by user or user's organizations
GET
/arrays/browser/owned/sidebar
Fetch a sidebar for arrays that are owned directly by user or user's organizations
udf 11
POST
/arrays/{namespace}/{array}/udf/submit
send a UDF to run against a specified array/URI registered to a group/project
POST
/udfs/generic/{namespace}
submit a generic UDF in the given namespace
POST
/udfs/arrays/{namespace}
submit a multi-array UDF in the given namespace
GET
/udf/{namespace}/{name}
get a specific UDF in the given namespace
POST
/udf/{namespace}/{name}
register a UDF in the given namespace
PATCH
/udf/{namespace}/{name}
update an existing registered UDF in the given namespace
DELETE
/udf/{namespace}/{name}
delete a registered UDF -- this will remove all sharing and can not be undone
GET
/udf/{namespace}/{name}/share
Get all sharing details of the UDF
PATCH
/udf/{namespace}/{name}/share
Share a UDF with a user
POST
/udf/{namespace}/{name}/copy
Copy a tiledb udf at the specified location
GET
/udf/{namespace}/{array}/end_timestamps
retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
query 5
POST
/arrays/{namespace}/{array}/query/submit
send a query to run against a specified array/URI registered to a group/project
POST
/arrays/{namespace}/{array}/query/submit_query_json
send a query to run against a specified array/URI registered to a group/project, returns JSON results
GET
/arrays/{namespace}/{array}/query/get_file
send a query to run against a specified array/URI registered to a group/project, returns file bytes
POST
/arrays/{namespace}/{array}/query/finalize
send a query to run against a specified array/URI registered to a group/project
POST
/arrays/{namespace}/{array}/query/est_result_sizes
send a query to run against a specified array/URI registered to a group/project
user 22
GET
/user
get a user
POST
/user
create a user
POST
/user/password_reset
reset user password
POST
/user/confirm_email
confirm user email
GET
/users/{username}
get a user
DELETE
/users/{username}
delete a user
PATCH
/users/{username}
update a user
GET
/credentials/{namespace}/aws
Check if aws keys are set
POST
/credentials/{namespace}/aws
Add aws keys
GET
/credentials/{namespace}/aws/{name}
Check if aws keys are set by name
PATCH
/credentials/{namespace}/aws/{name}
Update aws keys or associated buckets. This will update the key associations for each array in the namespace
DELETE
/credentials/{namespace}/aws/{name}
delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable
POST
/organizations/{organization}/user
add a user to an organization
GET
/organizations/{organization}/{username}
get a user from an organization
DELETE
/organizations/{organization}/{username}
delete a user from an organization
PATCH
/organizations/{organization}/{username}
update a user in an organization
GET
/session
Get session token for user
POST
/token
Request an authorization token, optionally taken a TokenRequest object to set parameters on the token
GET
/tokens
Fetch a list of user tokens
GET
/tokens/session
Fetch a list of user session tokens
DELETE
/tokens/{token}
revoke an authorization token
GET
/tokens/scopes
retrieves available token scopes for a user
organization 11
POST
/organization
create a organization, the user creating will be listed as owner
GET
/organizations
get all organizations that the user is member of
GET
/organizations/{organization}
get a organization
DELETE
/organizations/{organization}
delete a organization
PATCH
/organizations/{organization}
update a organization
POST
/organizations/{organization}/sso_domain
Create a new SSO connection that connects this organization to this domain.
GET
/organizations/{organization}/sso_domains
Lists all the SSO connections associated with the given organization.
GET
/organizations/{organization}/sso_domains/{uuid}
Gets details about the given SSO domain connection.
PATCH
/organizations/{organization}/sso_domains/{uuid}
Updates the configuration for the given SSO connection.
DELETE
/organizations/{organization}/sso_domains/{uuid}
Deletes the configuration for the given SSO connection.
POST
/organizations/{organization}/sso_domains/{uuid}/run_check
Immediately verify ownership of the specified SSO domain ownership claim.
tasks 3
GET
/tasks
Fetch a list of all array tasks a user has access to
GET
/task/{id}
Fetch an array task
GET
/task/{id}/result
Retrieve results of an array task
array_tasks 1
GET
/tasks/sidebar
sql 1
POST
/sql/{namespace}
Run a sql query
notebook 5
GET
/notebooks/server/{namespace}/status
Get status of the notebook server
DELETE
/notebooks/server/{namespace}
Shutdown a notebook server
PATCH
/notebooks/{namespace}/{array}/rename
update name on a notebok, moving related S3 object to new location
POST
/notebooks/{namespace}/{array}/copy
Copy a tiledb notebook at the specified location
POST
/notebooks/{namespace}/upload
Upload a notebook at the specified location
notebooks 2
GET
/notebooks/{namespace}/{array}/end_timestamps
retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated
POST
/notebooks/{namespace}/{array}/prune
prune fragments of the notebook
invitation 10
GET
/invitations
Fetch a list of invitations
POST
/invitations/{invitation}
Accepts invitation
DELETE
/invitations/{invitation}/{namespace}/{array}/share
Cancels array sharing invitation
DELETE
/invitations/group/{invitation}/{namespace}/{group_name}/share
Cancels group sharing invitation
DELETE
/invitations/{invitation}/{organization}/join
Cancels join organization invitation
POST
/invitations/{namespace}/{array}/share
Sends email to multiple recipients with sharing information regarding an array
POST
/invitations/group/{namespace}/{group}/share
Sends email to multiple recipients with sharing information regarding a group
POST
/invitations/{organization}/join
Sends email to multiple recipients with joining information regarding an organization
POST
/invitations/share_payment/{namespace}
Sends email to multiple recipients allowing them to use the payment instrument provided by the source namespace.
DELETE
/invitations/share_payment/{namespace}/{target}
Revokes invitation from the source namespace to the target.
favorites 20
GET
/arrays/favorites
Fetch a page of array favorites of connected user
GET
/arrays/favorites/uuids
Fetch all favorite array uuids of connected user
GET
/arrays/favorites/{namespace}/{name}
Fetch array favorite of a specific array
POST
/arrays/favorites/{namespace}/{name}
Add a new array favorite
DELETE
/arrays/favorites/{namespace}/{name}
Delete specific array favorite
GET
/notebooks/favorites
Fetch a page of notebook favorites of connected user
GET
/notebooks/favorites/uuids
Fetch all favorite notebook uuids of connected user
GET
/notebooks/favorites/{namespace}/{name}
Fetch notebook favorite of a specific notebook
POST
/notebooks/favorites/{namespace}/{name}
Add a new notebook favorite
DELETE
/notebooks/favorites/{namespace}/{name}
Delete specific notebook favorite
GET
/ml_models/favorites
Fetch a page of ML models favorites of connected user
GET
/ml_models/favorites/uuids
Fetch all favorite ML models uuids of connected user
GET
/ml_models/favorites/{namespace}/{name}
Fetch ML model favorite of a specific ML model
POST
/ml_models/favorites/{namespace}/{name}
Add a new ML model favorite
DELETE
/ml_models/favorites/{namespace}/{name}
Delete specific ML model favorite
GET
/udfs/favorites
Fetch a page of UDF favorites of connected user
GET
/udfs/favorites/uuids
Fetch all favorite UDF uuids of connected user
GET
/udfs/favorites/{namespace}/{name}
Fetch UDF favorite of a specific UDF
POST
/udfs/favorites/{namespace}/{name}
Add a new UDF favorite
DELETE
/udfs/favorites/{namespace}/{name}
Delete specific UDF favorite
files 3
POST
/files/{namespace}
Create a tiledb file at the specified location
POST
/files/{namespace}/upload
Upload a tiledb file at the specified location
POST
/files/{namespace}/{file}/export
Export a TileDB File back to its original file format
groups 17
GET
/groups/browser/owned/filters
Fetch data to initialize filters for the groups browser
GET
/groups/browser/owned
Returns one page of owned groups.
GET
/groups/browser/shared/filters
Fetch data to initialize filters for the groups browser
GET
/groups/browser/shared
Returns one page of shared groups.
GET
/groups/browser/public/filters
Fetch data to initialize filters for the groups browser
GET
/groups/browser/public
Returns one page of public groups.
GET
/groups/{group_namespace}/{group_name}/contents/filters
Fetch data to initialize filters for the group contents
POST
/groups/{group_namespace}/{group_name}/contents
Changes the contents of the group by adding/removing members.
GET
/groups/{group_namespace}/{group_name}/contents
Returns the contents of the group
POST
/groups/{namespace}/{array}/register
Registers an existing group in the namespace.
POST
/groups/{namespace}/create
Creates a new group in the namespace.
GET
/groups/{group_namespace}/{group_name}/share
Get all sharing details of the group
PATCH
/groups/{group_namespace}/{group_name}/share
Share a group with a namespace
GET
/groups/{group_namespace}/{group_name}
Returns the the group
PATCH
/groups/{group_namespace}/{group_name}
Changes attributes of the group
DELETE
/groups/{group_namespace}/{group_name}
Deletes the group. The assets are not deleted nor are not relocated to any other group
GET
/groups/{group_namespace}/{group_name}/content_activity
Returns the activity of group content
task_graph_logs 8
POST
/taskgraphs/{namespace}/log
Create a task graph log.
GET
/taskgraphs/logs
Fetch the task graph logs of a namespace the user has access to. The returned entries will include only summary data, and will not include information about the individual tasks that were executed. (…
GET
/taskgraphs/{namespace}/logs/{id}
Fetch information about a single task graph execution.
PATCH
/taskgraphs/{namespace}/logs/{id}
Update information about a single task graph execution.
POST
/taskgraphs/{namespace}/logs/{id}/report_client_node
POST
/taskgraphs/{namespace}/executions/{id}/resubmit
Resubmits a task graph in the given namespace using the associated execution id.
POST
/taskgraphs/{namespace}/executions/{id}/retry
Retries failed tasks of a task graph in the given namespace using the associated execution id.
POST
/taskgraphs/{namespace}/executions/{id}/stop
Stops a task graph execution in the given namespace using the associated associated execution id.
task_graphs 5
GET
/taskgraphs/{namespace}/graphs
Fetch the task graphs of a namespace the user has access to. The returned entries will include only summary data, and will not include information about the individual tasks that were executed. (This…
POST
/taskgraphs/{namespace}/graphs
Create a single task graph for execution.
GET
/taskgraphs/{namespace}/graphs/{id}
Fetch information about a single task graph.
PATCH
/taskgraphs/{namespace}/graphs/{id}
Update information about a single task graph execution.
POST
/taskgraphs/{namespace}/graphs/{id}/submit
Submit a single task graph for execution.
registered_task_graphs 6
GET
/taskgraphs/{namespace}/registered/{name}
Fetch the contents of this registered task graph.
POST
/taskgraphs/{namespace}/registered/{name}
Register a task graph in the given namespace, with the given name.
PATCH
/taskgraphs/{namespace}/registered/{name}
Update the contents of an existing registered task graph.
DELETE
/taskgraphs/{namespace}/registered/{name}
Delete the given registered task graph.
GET
/taskgraphs/{namespace}/registered/{name}/share
Get sharing policies for the task graph.
PATCH
/taskgraphs/{namespace}/registered/{name}/share
Share a task graph.
assets 3
GET
/assets/{namespace}
List assets in a namespace
GET
/public_assets
List public assets
POST
/assets/{namespace}/change_credentials
Changes the access credentials to the given assets
Schemas 187
The contract defines 187 schemas that model the data the API accepts and returns. The most detailed are ArrayTask (31 properties), ArrayInfo (27 properties), FragmentMetadata (25 properties), GroupInfo (22 properties). Each schema is shown below with its type and property counts.
ArrayType
string
TileDB array type
Datatype
string
TileDB data type
ActivityEventType
string
Type of activity logged
UDFLanguage
string
UDF Type
UDFType
string
UDF Type
ResultFormat
string
Data format of a result
Layout
string
Layout of array
Querytype
string
Type of query
Querystatus
string
Status of query
FilterType
string
TileDB filter types
FilterOption
string
TileDB filter option
OrganizationRoles
string
role user has in organization
ArrayActions
string
actions a user can take on an array
UDFActions
string
actions a user can take on a UDF
NamespaceActions
string
actions a user can take on an organization
DomainArray
object
Domain object for an array of each type
10 properties
Array
object
Represents an open array
3 properties
3 required
Attribute
object
Attribute of array
6 properties
4 required
Dimension
object
Dimension of array
6 properties
3 required
Domain
object
Domain of array
4 properties
4 required
Filter
object
Filter
2 properties
1 required
FilterPipeline
object
One or more filters to apply
1 property
ArraySchema
object
ArraySchema during creation or retrieval
11 properties
9 required
AttributeBufferHeader
object
Represents an attribute buffer header information
3 properties
3 required
Writer
object
4 properties
SubarrayRanges
object
A set of 1D ranges for a subarray
3 properties
Subarray
object
A Subarray
2 properties
SubarrayPartitioner
object
The subarray partitioner
6 properties
ReadState
object
state for reads
4 properties
QueryReader
object
Read struct (can't be called reader due to class name conflict)
6 properties
Query
object
9 properties
7 required
NonEmptyDomain
object
object representing a non-empty domain
2 properties
2 required
AttributeBufferSize
object
object representing buffer size of an attribute
3 properties
3 required
MaxBufferSizes
object
a list of max buffer sizes, one per attribute
1 property
ArrayMetadataEntry
object
key/value pair representing an array metadata map entry
5 properties
ArrayMetadata
object
user's TileDB array metadata
1 property
MetadataStringifiedEntry
object
key/value pair representing an asset metadata map entry
3 properties
TileDBConfig
object
TileDB config used for interaction with the embedded library
1 property
ArrayActivityLog
object
Actvity of an Array
9 properties
ArrayTaskType
string
Synchronous Task Type
ArrayTaskStatus
string
Status of array task
ArrayTaskLog
object
Array task stderr/stdout logs
2 properties
ArrayTask
object
Synchronous Task to Run
31 properties
PaginationMetadata
object
4 properties
ArrayTaskData
object
Object including array tasks and metadata
2 properties
ArrayTaskBrowserSidebar
object
Object for ui array tasks browser page
3 properties
LastAccessedArray
object
Information related to last access of an array
5 properties
ArraySample
object
Sample data from array
1 property
ArrayMetadataJson
object
Metadata from array in Json format
NonEmptyDomainJson
object
Non-empty domain from array in Json format
ArrayBrowserData
object
Object including array info and pagination metadata
2 properties
ArrayEndTimestampData
object
Object including array endtimestamps (list of Unix epoch timestamps in milliseconds) and pagination metadata
2 properties
ArrayBrowserSidebar
object
Object for ui array tasks browser page
3 properties
Error
object
3 properties
User
object
User
19 properties
1 required
OrganizationUser
object
user in an organization
8 properties
DomainVerificationStatus
string
The current status of the claim on the domain.
DomainCheckStatus
string
The status of a single check on a domain's status.
DomainCheckResult
object
The record of a check of a single domain's status.
2 properties
SSODomainConfig
object
The information used to set up a single-sign on connection to a customer domain.
8 properties
SSODomainConfigResponse
object
The response to a request for the list of domain claims associated with a particular organization.
1 property
SSODomainSetup
object
Configuration settings to verify ownership of a given domain. At least one of these must be completed enable user login from the domain.
3 properties
Organization
object
Organization
17 properties
1 required
OrganizationUpdate
object
OrganizationUpdate
6 properties
AssetLocations
object
Custom storage locations on a per–asset type basis. If any is unset, a suffix of the owning (user/organization) defaults3path is used.
7 properties
StorageLocation
object
The path at which a given asset will be stored, and the credentials used to access that asset.
2 properties
ArraySharing
object
details for sharing a given array
3 properties
UDFSharing
object
details for sharing a given UDF
3 properties
FileType
string
File types represented as TileDB arrays
AssetType
string
Asset types represented as TileDB arrays
FilePropertyName
string
File property assigned to a specific file (array)
PricingType
string
Pricing types
PricingCurrency
string
Currency of pricing
PricingUnitLabel
string
Unit label
PricingAggregateUsage
string
Specifies a usage aggregation strategy for pricings of usagetype=metered
PricingInterval
string
Interval for pricing
Pricing
object
Pricing created by converting an array to product
13 properties
Subscription
object
Subscription of a user (customer) to another user's arrays
4 properties
ArrayInfo
object
metadata of an array
27 properties
ArrayInfoUpdate
object
metadata of an array
11 properties
TokenRequest
object
A request from a user for an api token
3 properties
Token
object
A api token and its metadata
5 properties
AWSAccessCredentials
object
Model representing aws keys or service role, service roles are currently ignored, but will be preferred option in the future
8 properties
SSOProvider
string
Single sign on provider
PublicShareFilter
string
Query parameter to get array metadatas
DimensionCoordinate
object
A single, typed coordinate for a dimension
10 properties
UDFSubarrayRange
object
A dimension range to query
3 properties
UDFSubarray
object
Subarray bounds to query for a UDF to operate on
2 properties
QueryRanges
object
Subarray bounds to query
2 properties
QueryJson
object
Query returning results as JSON
2 properties
GenericUDF
object
User-defined function
17 properties
UDFArrayDetails
object
Contains array details for multi-array query including uri, ranges buffers
4 properties
MultiArrayUDF
object
User-defined function
22 properties
UDFImage
object
Defines a set of images related to a specific name
3 properties
UDFImageVersion
object
Defines an image that belongs to a set of images having a version
7 properties
UDFInfoUpdate
object
User-defined function that can persist in db, used and shared multiple times
11 properties
UDFInfo
object
User-defined function that can persist in db, used and shared multiple times
8 properties
SQLParameters
object
Parameters for running sql query
11 properties
NotebookStatus
object
Status details of a notebook server
12 properties
PodStatus
string
List of all available pod statuses
ArrayFavorite
object
A user-favorite array item
3 properties
ArrayFavoritesData
object
Object including array favorites and pagination metadata
2 properties
NotebookFavorite
object
A user-favorite notebook item
3 properties
NotebookFavoritesData
object
Object including notebook favorites and pagination metadata
2 properties
UDFFavorite
object
A user-favorite UDF item
3 properties
UDFFavoritesData
object
Object including UDF favorites and pagination metadata
2 properties
MLModelFavorite
object
A user-favorite MLModel item
3 properties
MLModelFavoritesData
object
Object including MLModel favorites and pagination metadata
2 properties
InvitationType
string
List of values that InvitationType can take
InvitationStatus
string
List of values that InvitationStatus can take
InvitationArrayShareEmail
object
Encapsulates information regarding inviting people using email to share array, same permissions for all invitees
2 properties
2 required
InvitationFailedRecipients
object
Encapsulates information regarding the failed invitation recipients
1 property
1 required
InvitationGroupShareEmail
object
Encapsulates information regarding inviting people using email to share group, same permissions for all invitees
3 properties
3 required
InvitationOrganizationJoinEmail
object
Encapsulates information regarding inviting people using email to join organization, same permissions for all invitees
3 properties
2 required
Invitation
object
Invitations to share or collaborate
20 properties
InvitationData
object
Object including invitations and metadata
2 properties
TokenScope
string
An api token scope available for creation
FileCreate
object
Input/Output information required to create a new file
3 properties
FileCreated
object
Created file name and information
2 properties
FileUploaded
object
Uploaded file name and information
3 properties
1 required
FileExport
object
Output information required to export a file
1 property
FileExported
object
Output uri of the exported file
1 property
NotebookCopy
object
Output information required to copy a notebook
3 properties
NotebookCopied
object
Copied notebook uri and information
4 properties
1 required
UDFCopy
object
information required to copy a udf
3 properties
UDFCopied
object
Copied udf uri and information
4 properties
1 required
GroupActions
string
actions a user can take on a group
GroupType
string
Group type is a hint for the groups contents and TileDB Cloud may use a specialized viewer for each type
GroupTypeMetadataKey
string
A group type is stored in the group metadata using this key
GroupInfo
object
metadata of a group
22 properties
GroupEntry
object
Object describing a single member of a group, which can be an array or a group
3 properties
GroupContents
object
Object including a page of members of a group and pagination metadata
2 properties
GroupBrowserData
object
Object including group info and pagination metadata
2 properties
GroupBrowserFilterData
object
Object with data to fill browser filter
2 properties
GroupContentsFilterData
object
Object with data to fill contents filter
1 property
GroupCreate
object
Initial attributes for the creation of a group.
9 properties
GroupRegister
object
Initial attributes for the registration of a an existing group.
9 properties
GroupUpdate
object
Updates for a group. New values for the attributes.
7 properties
GroupMemberType
string
File types that can be included in groups
GroupMemberAssetType
string
Specific file types of group members
GroupMember
object
A groups member, array or another groups, to add or remove from an existing group.
3 properties
GroupChanges
object
A request to change the members of a group. Contains assets to add or remove.
2 properties
GroupSharing
object
sharing state of a group with a namespace
4 properties
GroupSharingRequest
object
a request to share a group and all the contents with a namespace
3 properties
GroupContentActivity
object
Object containing activity of an asset of a group
2 properties
GroupContentActivityResponse
object
Object containing activity logs of group content along with the pagination metadata
2 properties
TaskGraphLogRunLocation
string
The location where an individual node of a task graph is executed.
TaskGraphLogStatus
string
The status of a given task graph execution.
TaskGraphType
string
The type of a task graph.
TaskGraphLog
object
Logging information about the execution of a task graph.
18 properties
TaskGraphNodeMetadata
object
Metadata about an individual node in a task graph.
7 properties
TaskGraphLogsData
object
Response data for a task graph list, including pagination metadata.
2 properties
TaskGraphClientNodeStatus
object
A report of the execution status of a node that ran on the client side.
2 properties
TaskGraph
object
Information about a task graph.
10 properties
TaskGraphs
object
Information about a series of task graphs.
1 property
RegisteredTaskGraph
object
The structure and metadata of a task graph that can be stored on TileDB Cloud and executed by users who have access to it.
8 properties
TaskGraphActions
string
actions a user can take on a UDF
TaskGraphSharing
object
details for sharing a given registered task graph
3 properties
TaskGraphNode
object
Information about a single node within a registered task graph. A single node represents one piece of data or a computational step; either as an input value, a…
10 properties
TGArrayNodeData
object
The details of an array that should be queried and provided as the input to a UDF Node. This is essentially a UDFArrayDetails, but you’re allowed to provide mo…
3 properties
TGQueryRanges
object
Parameterizable version of QueryRanges.
3 properties
TGInputNodeData
object
Specifies that a node is an “input value”, allowing for parameterized task graphs. An input node may not depend upon any other nodes.
2 properties
TGSQLNodeData
object
A node specifying an SQL query to execute in TileDB Cloud.
5 properties
TGUDFNodeData
object
A node specifying the execution of a user-defined function.
6 properties
TGUDFArgument
object
A single argument to a UDF. This may represent a positional argument or a named argument, depending upon whether name is set.
2 properties
TGArgValue
An argument provided to a node. This is one of a direct value (i.e., a raw JSON value) or a TGSentinel. For example this Python value: {"a": [1, "pipe", range(…
TGUDFEnvironment
object
Metadata about the environment where we want to execute a UDF.
9 properties
FragmentMetadata
object
Fragment Metadata
25 properties
SingleFragmentInfo
object
Single Fragment info of an array
2 properties
FragmentInfo
object
Fragment info of an array
3 properties
FragmentInfoRequest
object
Fragment info request
1 property
ArrayConsolidationRequest
object
Request to consolidate an array
2 properties
ArrayVacuumRequest
object
Request to consolidate an array
1 property
Enumeration
object
The enumerations of a single attribute
7 properties
LoadEnumerationsRequest
object
Request to return enumerations for attributes
2 properties
LoadEnumerationsResponse
object
Contains the enumerations of the array's attributes
1 property
LoadArraySchemaRequest
object
Request to load an array schema
1 property
LoadArraySchemaResponse
object
Contains the latest schema and all schemas for the opened array
2 properties
RetryStrategy
object
RetryStrategy provides controls on how to retry a taskgraph node
4 properties
Backoff
object
Backoff is a backoff strategy to use within retryStrategy
3 properties
RetryPolicy
string
RetryPolicy is a policy of node statuses that will be retried
AssetBackingType
string
The technology that an asset is backed by
AssetOwnershipLevel
string
The ownership level of the asset
MetadataStringified
object
The user's TileDB metadata
1 property
AssetInfo
object
metadata of an asset
10 properties
AssetListResponse
object
Asset associated with a TileDB Cloud account
2 properties
ChangeAssetCredentialsRequest
object
Request body to change the credentials of the given assets
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Database#Multimodal Data#Data Management#Analytics#Life Sciences
Where this information came from
This is an independent, third-party profile of TileDB Storage Platform API (v1), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.