DNAnexus Documentation
APIDownloadsIndex of dx CommandsLegal
  • Overview
  • Getting Started
    • DNAnexus Essentials
    • Key Concepts
      • Projects
      • Organizations
      • Apps and Workflows
    • User Interface Quickstart
    • Command Line Quickstart
    • Developer Quickstart
    • Developer Tutorials
      • Bash
        • Bash Helpers
        • Distributed by Chr (sh)
        • Distributed by Region (sh)
        • SAMtools count
        • TensorBoard Example Web App
        • Git Dependency
        • Mkfifo and dx cat
        • Parallel by Region (sh)
        • Parallel xargs by Chr
        • Precompiled Binary
        • R Shiny Example Web App
      • Python
        • Dash Example Web App
        • Distributed by Region (py)
        • Parallel by Chr (py)
        • Parallel by Region (py)
        • Pysam
      • Web App(let) Tutorials
        • Dash Example Web App
        • TensorBoard Example Web App
      • Concurrent Computing Tutorials
        • Distributed
          • Distributed by Region (sh)
          • Distributed by Chr (sh)
          • Distributed by Region (py)
        • Parallel
          • Parallel by Chr (py)
          • Parallel by Region (py)
          • Parallel by Region (sh)
          • Parallel xargs by Chr
  • User
    • Login and Logout
    • Projects
      • Project Navigation
      • Path Resolution
    • Running Apps and Workflows
      • Running Apps and Applets
      • Running Workflows
      • Running Nextflow Pipelines
      • Running Batch Jobs
      • Monitoring Executions
      • Job Notifications
      • Job Lifecycle
      • Executions and Time Limits
      • Executions and Cost and Spending Limits
      • Smart Reuse (Job Reuse)
      • Apps and Workflows Glossary
      • Tools List
    • Cohort Browser
      • Chart Types
        • Row Chart
        • Histogram
        • Box Plot
        • List View
        • Grouped Box Plot
        • Stacked Row Chart
        • Scatter Plot
        • Kaplan-Meier Survival Curve
      • Locus Details Page
    • Using DXJupyterLab
      • DXJupyterLab Quickstart
      • Running DXJupyterLab
        • FreeSurfer in DXJupyterLab
      • Spark Cluster-Enabled DXJupyterLab
        • Exploring and Querying Datasets
      • Stata in DXJupyterLab
      • Running Older Versions of DXJupyterLab
      • DXJupyterLab Reference
    • Using Spark
      • Apollo Apps
      • Connect to Thrift
      • Example Applications
        • CSV Loader
        • SQL Runner
        • VCF Loader
      • VCF Preprocessing
    • Environment Variables
    • Objects
      • Describing Data Objects
      • Searching Data Objects
      • Visualizing Data
      • Filtering Objects and Jobs
      • Archiving Files
      • Relational Database Clusters
      • Symlinks
      • Uploading and Downloading Files
        • Small File Sets
          • dx upload
          • dx download
        • Batch
          • Upload Agent
          • Download Agent
    • Platform IDs
    • Organization Member Guide
    • Index of dx commands
  • Developer
    • Developing Portable Pipelines
      • dxCompiler
    • Cloud Workstation
    • Apps
      • Introduction to Building Apps
      • App Build Process
      • Advanced Applet Tutorial
      • Bash Apps
      • Python Apps
      • Spark Apps
        • Table Exporter
        • DX Spark Submit Utility
      • HTTPS Apps
        • Isolated Browsing for HTTPS Apps
      • Transitioning from Applets to Apps
      • Third Party and Community Apps
        • Community App Guidelines
        • Third Party App Style Guide
        • Third Party App Publishing Checklist
      • App Metadata
      • App Permissions
      • App Execution Environment
        • Connecting to Jobs
      • Dependency Management
        • Asset Build Process
        • Docker Images
        • Python package installation in Ubuntu 24.04 AEE
      • Job Identity Tokens for Access to Clouds and Third-Party Services
      • Enabling Web Application Users to Log In with DNAnexus Credentials
      • Types of Errors
    • Workflows
      • Importing Workflows
      • Introduction to Building Workflows
      • Building and Running Workflows
      • Workflow Build Process
      • Versioning and Publishing Global Workflows
      • Workflow Metadata
    • Ingesting Data
      • Molecular Expression Assay Loader
        • Common Errors
        • Example Usage
        • Example Input
      • Data Model Loader
        • Data Ingestion Key Steps
        • Ingestion Data Types
        • Data Files Used by the Data Model Loader
        • Troubleshooting
      • Dataset Extender
        • Using Dataset Extender
    • Dataset Management
      • Rebase Cohorts and Dashboards
      • Assay Dataset Merger
      • Clinical Dataset Merger
    • Apollo Datasets
      • Dataset Versions
      • Cohorts
    • Creating Custom Viewers
    • Client Libraries
      • Support for Python 3
    • Walkthroughs
      • Creating a Mixed Phenotypic Assay Dataset
      • Guide for Ingesting a Simple Four Table Dataset
    • DNAnexus API
      • Entity IDs
      • Protocols
      • Authentication
      • Regions
      • Nonces
      • Users
      • Organizations
      • OIDC Clients
      • Data Containers
        • Folders and Deletion
        • Cloning
        • Project API Methods
        • Project Permissions and Sharing
      • Data Object Lifecycle
        • Types
        • Object Details
        • Visibility
      • Data Object Metadata
        • Name
        • Properties
        • Tags
      • Data Object Classes
        • Records
        • Files
        • Databases
        • Drives
        • DBClusters
      • Running Analyses
        • I/O and Run Specifications
        • Instance Types
        • Job Input and Output
        • Applets and Entry Points
        • Apps
        • Workflows and Analyses
        • Global Workflows
        • Containers for Execution
      • Search
      • System Methods
      • Directory of API Methods
      • DNAnexus Service Limits
  • Administrator
    • Billing
    • Org Management
    • Single Sign-On
    • Audit Trail
    • Integrating with External Services
    • Portal Setup
    • GxP
      • Controlled Tool Access (allowed executables)
  • Science Corner
    • Scientific Guides
      • Somatic Small Variant and CNV Discovery Workflow Walkthrough
      • SAIGE GWAS Walkthrough
      • LocusZoom DNAnexus App
      • Human Reference Genomes
    • Using Hail to Analyze Genomic Data
    • Open-Source Tools by DNAnexus Scientists
    • Using IGV Locally with DNAnexus
  • Downloads
  • FAQs
    • EOL Documentation
      • Python 3 Support and Python 2 End of Life (EOL)
    • Automating Analysis Workflow
    • Backups of Customer Data
    • Developing Apps and Applets
    • Importing Data
    • Platform Uptime
    • Legal and Compliance
    • Sharing and Collaboration
    • Product Version Numbering
  • Release Notes
  • Technical Support
  • Legal
Powered by GitBook

Copyright 2025 DNAnexus

On this page

Was this helpful?

Export as PDF
  1. Developer
  2. DNAnexus API

Directory of API Methods

Last updated 1 year ago

Was this helpful?

/system/findAnalyses
/system/findApps
/system/findDataObjects
/system/findDatabases
/system/findExecutions
/system/findJobs
/system/findOrgs
/system/findProjectMembers
/system/findProjects
/class-xxxx/clone
/class-xxxx/listProjects
/class-xxxx/addTypes
/class-xxxx/removeTypes
/analysis-xxxx/addTags
/analysis-xxxx/describe
/analysis-xxxx/removeTags
/analysis-xxxx/setProperties
/analysis-xxxx/terminate
/analysis-xxxx/update
/workflow-xxxx/addStage
/workflow-xxxx/describe
/workflow-xxxx/dryRun
/workflow-xxxx/isStageCompatible
/workflow-xxxx/moveStage
/workflow-xxxx/overwrite
/workflow-xxxx/removeStage
/workflow-xxxx/run
/workflow-xxxx/update
/workflow-xxxx/updateStageExecutable
/workflow-xxxx/validateBatch
/workflow/new
/app-xxxx[/yyyy]/addAuthorizedUsers
/app-xxxx[/yyyy]/addCategories
/app-xxxx[/yyyy]/addDevelopers
/app-xxxx[/yyyy]/addTags
/app-xxxx[/yyyy]/delete
/app-xxxx[/yyyy]/describe
/app-xxxx[/yyyy]/get
/app-xxxx[/yyyy]/install
/app-xxxx[/yyyy]/isCompatible
/app-xxxx[/yyyy]/listAuthorizedUsers
/app-xxxx[/yyyy]/listCategories
/app-xxxx[/yyyy]/listDevelopers
/app-xxxx[/yyyy]/publish
/app-xxxx[/yyyy]/removeAuthorizedUsers
/app-xxxx[/yyyy]/removeCategories
/app-xxxx[/yyyy]/removeDevelopers
/app-xxxx[/yyyy]/removeTags
/app-xxxx[/yyyy]/run
/app-xxxx[/yyyy]/uninstall
/app-xxxx[/yyyy]/update
/app-xxxx[/yyyy]/validateBatch
/app/new
/class-xxxx/addTags
/class-xxxx/removeTags
/class-xxxx/listFolder
/class-xxxx/move
/class-xxxx/newFolder
/class-xxxx/removeFolder
/class-xxxx/removeObjects
/class-xxxx/renameFolder
/class-xxxx/getDetails
/class-xxxx/setDetails
/applet-xxxx/describe
/applet-xxxx/get
/applet-xxxx/run
/applet-xxxx/validateBatch
/applet/new
/job/new
/job-xxxx/addTags
/job-xxxx/describe
/job-xxxx/getIdentityToken
/job-xxxx/removeTags
/job-xxxx/setProperties
/job-xxxx/terminate
/job-xxxx/update
/class-xxxx/rename
/class-xxxx/close
/class-xxxx/setVisibility
/class-xxxx/setProperties
/container-xxxx/describe
/database-xxxx/describe
/database-xxxx/relocate
/drive-xxxx/describe
/drive-xxxx/disable
/drive-xxxx/update
/drive/new
/globalworkflow-xxxx[/yyyy]/addAuthorizedUsers
/globalworkflow-xxxx[/yyyy]/addCategories
/globalworkflow-xxxx[/yyyy]/addDevelopers
/globalworkflow-xxxx[/yyyy]/addTags
/globalworkflow-xxxx[/yyyy]/delete
/globalworkflow-xxxx[/yyyy]/describe
/globalworkflow-xxxx[/yyyy]/listAuthorizedUsers
/globalworkflow-xxxx[/yyyy]/listCategories
/globalworkflow-xxxx[/yyyy]/listDevelopers
/globalworkflow-xxxx[/yyyy]/publish
/globalworkflow-xxxx[/yyyy]/removeAuthorizedUsers
/globalworkflow-xxxx[/yyyy]/removeCategories
/globalworkflow-xxxx[/yyyy]/removeDevelopers
/globalworkflow-xxxx[/yyyy]/removeTags
/globalworkflow-xxxx[/yyyy]/run
/globalworkflow-xxxx[/yyyy]/update
/globalworkflow/new
/file-xxxx/close
/file-xxxx/describe
/file-xxxx/download
/file-xxxx/upload
/file/new
/dbcluster-xxxx/describe
/dbcluster-xxxx/start
/dbcluster-xxxx/stop
/dbcluster-xxxx/terminate
/dbcluster/new
/project-xxxx/addTags
/project-xxxx/archive
/project-xxxx/countRootExecutions
/project-xxxx/describe
/project-xxxx/destroy
/project-xxxx/removeTags
/project-xxxx/setProperties
/project-xxxx/unarchive
/project-xxxx/update
/project-xxxx/updateSponsorship
/project/new
/system/getProjectTags
/project-xxxx/acceptTransfer
/project-xxxx/decreasePermissions
/project-xxxx/invite
/project-xxxx/leave
/project-xxxx/transfer
/record-xxxx/describe
/record/new
/org-xxxx/bulkUpdateProjectLimit
/org-xxxx/describe
/org-xxxx/destroy
/org-xxxx/findApps
/org-xxxx/findMembers
/org-xxxx/findProjects
/org-xxxx/invite
/org-xxxx/removeMember
/org-xxxx/setMemberAccess
/org-xxxx/update
/org/new
/user-xxxx/describe
/user-xxxx/update
/system/bulkRankUpdate
/system/describeDataObjects
/system/describeExecutions
/system/describeProjects
/system/generateBatchInputs
/system/resolveDataObjects
/system/whoami