Jump to Content

Home Guides Recipes API Reference Changelog Discussions

Changelog API Reference Log In

Changelog API Reference Log In

Home Guides Recipes API Reference Changelog Discussions

Pennsieve Swagger

Data
Discussions
Annotations
DataSets
Packages
Imaging
API Token
TimeSeries
Collections
Organizations
Files
- creates a manifest for an uploaded file group, and puts it in s3post
- returns packages that will be created from a given list of filespost
Contributors
User
Account
- create a new user from a user invitepost

Discover Service

Datasets
Tags
- get all dataset tagsget
Search
Metrics
- Get Organization Dataset Metricsget
- metricsget
Packages
- get the files from the sourcePackageId of a packageget

Pennsieve API Version 2

Upload Service
Metadata Service
- Get models for datasetget
- Get package metadataget
Metadata Service|Search
- Search metadata graphpost
- Autocomplete for searchpost
Metadata Service|Records
- Create record relationshipspost
Publishing Service Information
- Get Publishing Service Informationget
Publishing Service
Datasets Service|Trashcan
- List trashcan contents for a dataset by folderget
Packages Service
- Restore deleted itemspost
Integration Service
- Execute integrationpost
- Get integration by idget
Discover/Rehydration Service
- Execute rehydrationpost
Readme Service
- Get Pennsieve readme.io doc by slugget
Account Service
Compute Node Service

Model Service

Models
Records
Queries
- Execute a Metadata Record Querypost
Proxies
Relationships
Properties
- Return known units for Long and Double propertiesget
- Return known string subtypes and human readable labelsget

Zipit Service

/
- Returns a stream of file(s) from the pennsieve platformpost
/discover
- Returns a stream of file(s) from pennsieve discoverpost

Pennsieve Swagger

Getting Started With Your API

Pennsieve Swagger

Data
Discussions
Annotations
Health
- performs a health checkget
DataSets
Packages
Imaging
API Token
Security
- (DEPRECATED) gets temporary credentials for a users folder in the s3 bucketget
TimeSeries
DataSetsInternal
- touch the updatedAt timestamp for a data set (Internal Use Only)post
Collections
Webhooks
Organizations
Files
- creates a manifest for an uploaded file group, and puts it in s3post
- DEPRECATED: returns packages that will be created from a given list of filespost
Onboarding
- Adds a new onboarding event for the current userpost
- Gets all onboarding events for the current userget
Contributors
User
Account
- create a new user from a user invitepost
- Self-service sign up a new user accountpost
DataCanvas

Pennsieve Swagger

Data
Discussions
Annotations
Health
- performs a health checkget
DataSets
Packages
Imaging
API Token
Security
- (DEPRECATED) gets temporary credentials for a users folder in the s3 bucketget
TimeSeries
DataSetsInternal
- touch the updatedAt timestamp for a data set (Internal Use Only)post
Collections
Webhooks
Organizations
Files
- creates a manifest for an uploaded file group, and puts it in s3post
- DEPRECATED: returns packages that will be created from a given list of filespost
Onboarding
- Adds a new onboarding event for the current userpost
- Gets all onboarding events for the current userget
Contributors
User
Account
- create a new user from a user invitepost
- Self-service sign up a new user accountpost
DataCanvas

Pennsieve Swagger DEV

Data
Discussions
Annotations
Health
- performs a health checkget
DataSets
Packages
Imaging
API Token
Security
- (DEPRECATED) gets temporary credentials for a users folder in the s3 bucketget
TimeSeries
DataSetsInternal
- touch the updatedAt timestamp for a data set (Internal Use Only)post
Collections
Webhooks
Organizations
Files
- creates a manifest for an uploaded file group, and puts it in s3post
- DEPRECATED: returns packages that will be created from a given list of filespost
Onboarding
- Adds a new onboarding event for the current userpost
- Gets all onboarding events for the current userget
Contributors
User
Account
- create a new user from a user invitepost
- Self-service sign up a new user accountpost
DataCanvas

Powered by

Pennsieve Swagger

Data
Discussions
Annotations
DataSets
Packages
Imaging
API Token
TimeSeries
Collections
Organizations
Files
- creates a manifest for an uploaded file group, and puts it in s3post
- returns packages that will be created from a given list of filespost
Contributors
User
Account
- create a new user from a user invitepost

Discover Service

Datasets
Tags
- get all dataset tagsget
Search
Metrics
- Get Organization Dataset Metricsget
- metricsget
Packages
- get the files from the sourcePackageId of a packageget

Pennsieve API Version 2

Upload Service
Metadata Service
- Get models for datasetget
- Get package metadataget
Metadata Service|Search
- Search metadata graphpost
- Autocomplete for searchpost
Metadata Service|Records
- Create record relationshipspost
Publishing Service Information
- Get Publishing Service Informationget
Publishing Service
Datasets Service|Trashcan
- List trashcan contents for a dataset by folderget
Packages Service
- Restore deleted itemspost
Integration Service
- Execute integrationpost
- Get integration by idget
Discover/Rehydration Service
- Execute rehydrationpost
Readme Service
- Get Pennsieve readme.io doc by slugget
Account Service
Compute Node Service

Model Service

Models
Records
Queries
- Execute a Metadata Record Querypost
Proxies
Relationships
Properties
- Return known units for Long and Double propertiesget
- Return known string subtypes and human readable labelsget

Zipit Service

/
- Returns a stream of file(s) from the pennsieve platformpost
/discover
- Returns a stream of file(s) from pennsieve discoverpost

Pennsieve Swagger

Getting Started With Your API

Pennsieve Swagger

Data
Discussions
Annotations
Health
- performs a health checkget
DataSets
Packages
Imaging
API Token
Security
- (DEPRECATED) gets temporary credentials for a users folder in the s3 bucketget
TimeSeries
DataSetsInternal
- touch the updatedAt timestamp for a data set (Internal Use Only)post
Collections
Webhooks
Organizations
Files
- creates a manifest for an uploaded file group, and puts it in s3post
- DEPRECATED: returns packages that will be created from a given list of filespost
Onboarding
- Adds a new onboarding event for the current userpost
- Gets all onboarding events for the current userget
Contributors
User
Account
- create a new user from a user invitepost
- Self-service sign up a new user accountpost
DataCanvas

Pennsieve Swagger

Data
Discussions
Annotations
Health
- performs a health checkget
DataSets
Packages
Imaging
API Token
Security
- (DEPRECATED) gets temporary credentials for a users folder in the s3 bucketget
TimeSeries
DataSetsInternal
- touch the updatedAt timestamp for a data set (Internal Use Only)post
Collections
Webhooks
Organizations
Files
- creates a manifest for an uploaded file group, and puts it in s3post
- DEPRECATED: returns packages that will be created from a given list of filespost
Onboarding
- Adds a new onboarding event for the current userpost
- Gets all onboarding events for the current userget
Contributors
User
Account
- create a new user from a user invitepost
- Self-service sign up a new user accountpost
DataCanvas

Pennsieve Swagger DEV

Data
Discussions
Annotations
Health
- performs a health checkget
DataSets
Packages
Imaging
API Token
Security
- (DEPRECATED) gets temporary credentials for a users folder in the s3 bucketget
TimeSeries
DataSetsInternal
- touch the updatedAt timestamp for a data set (Internal Use Only)post
Collections
Webhooks
Organizations
Files
- creates a manifest for an uploaded file group, and puts it in s3post
- DEPRECATED: returns packages that will be created from a given list of filespost
Onboarding
- Adds a new onboarding event for the current userpost
- Gets all onboarding events for the current userget
Contributors
User
Account
- create a new user from a user invitepost
- Self-service sign up a new user accountpost
DataCanvas

Powered by

add this dataset to a collection

put https://api.pennsieve.io/datasets/{id}/collections

Language

Authorization

Query

Log in to use your API keys

Click Try It! to start a request and see the response here!