Pricing
Documentation
Login

Get Started

Introduction

GETInitiate SAML SSO login for a specific organization
POSTLog into the account
POSTLog into the account using Google
POSTLog into the account using refresh token
POSTCheck whether SAML SSO is enabled
POSTSAML assertion consumer service for an organization
POSTSend reset password email
POSTLogout

GETRetrieve profile
GETRetrieve organization
GETList all licenses
GETRetrieve a license
GETRetrieve a license's feature entitlements
GETList all activations
GETRetrieve an activation
GETList all releases
GETList all release platforms
GETList all release channels
GETList all products
POSTGenerate the 2FA secret
POSTGenerate the 2FA recovery codes
PATCHUpdate profile
PATCHUpdate the current user's organization alias

Products

GETList all products
GETRetrieve a product
GETDownload the Product Data file
POSTCreate a product
PATCHUpdate a product
DELETEDelete a product
DELETEDelete a product metadata field

Features

GETList all features
GETRetrieve a feature
POSTCreate a feature
PATCHUpdate a feature
DELETEDelete a feature

Entitlement Sets

GETList all entitlement sets
GETRetrieve an entitlement set
GETGet all feature entitlements belonging to an entitlement set
POSTCreate an entitlement set
POSTAdd a feature entitlement to an entitlement set
PATCHUpdate an entitlement set
PATCHUpdate a feature entitlement belonging to an entitlement set
DELETEDelete an entitlement set
DELETERemove a feature entitlement from an entitlement set.

Licenses

GETList all licenses
GETRetrieve a license
GETExport all licenses
GETGet all feature entitlements for a license
GETList all subscription logs
GETRetrieve a subscription log
POSTCreate a license
POSTLookup a license
POSTRotate license key
POSTRenew license
POSTRenew license maintenance
POSTReset license meter attribute
POSTCreate a new feature entitlement for a license
PATCHUpdate a license
PATCHUpdate license subscription parameters
PATCHUpdate license expiration
PATCHUpdate license maintenance expiration
PATCHUpdate a feature entitlement for a license
DELETEDelete a license
DELETEDelete a license meter attribute
DELETEDelete a license metadata field
DELETEDelete a feature entitlement for a license

License Templates

GETList all license templates
GETRetrieve a license template
POSTCreate a license template
PATCHUpdate a license template
DELETEDelete a license template

Maintenance Policies

GETList all maintenance policies
GETRetrieve a maintenance policy
POSTCreate a maintenance policy
PATCHUpdate a maintenance policy
PATCHUpdate maintenance policy subscription parameters.
DELETEDelete a maintenance policy

Activations

GETList all activations
GETRetrieve an activation
GETGet all feature entitlements for an activation
GETExport activations
POSTCreate an activation
POSTCreate an offline activation
POSTDelete an activation
POSTDelete an activation offline
POSTIncrement an activation meter attribute
PATCHUpdate an activation
DELETEBulk delete activations
DELETEDelete an activation

Activation Events

GETList all activation events
GETRetrieve an activation event
GETExport activation events

Trial Activations

GETList all trial activations
GETRetrieve a trial activation
GETExport all trial activations
POSTCreate a trial activation
POSTExtend a trial activation
POSTCreate an offline trial activation
PATCHUpdate a trial activation
PATCHUpdate trial activation expiry date
DELETEDelete a trial activation

Trial Policies

GETList all trial policies
GETRetrieve a trial policy
POSTCreate a trial policy
PATCHUpdate a trial policy
DELETEDelete a trial policy

Releases

GETList all releases
GETRetrieve a release
GETCheck for an update
GETGet latest release
GETCheck if release is allowed
GETGet release storage space information
POSTCreate a release
POSTPublish release
POSTArchive release
PATCHUpdate a release
DELETEDelete a release

Release Files

GETList all release files
GETRetrieve a release file
POSTCreate a release file
DELETEDelete a release file

Release Platforms

GETList all release platforms
GETRetrieve a release platform
POSTCreate a release platform
PATCHUpdate a release platform
DELETEDelete a release platform

Release Channels

GETList all release channels
GETRetrieve a release channel
POSTCreate a release channel
PATCHUpdate a release channel
DELETEDelete a release channel

Release Download Events

GETList all release download events
GETRetrieve a release download event
GETExport release download events

GETList all users
GETRetrieve a user
GETExport all users
POSTCreate a user
POSTUpdate password
POSTGenerate reset password token
POSTReset password
PATCHUpdate a user
DELETEDelete a user
DELETEDelete a user metadata field

Organizations

GETList all organizations
GETRetrieve an organization
POSTCreate an organization
PATCHUpdate an organization
DELETEDelete an organization

Organization Users

GETList all organization users
GETRetrieve an organization user
POSTCreate an organization user
PATCHUpdate an organization user
DELETEDelete an organization user

Organization User Groups

GETList all organization user groups
GETRetrieve an organization user group
POSTCreate an organization user group
PATCHUpdate an organization user group
DELETEDelete an organization user group

Organization Licenses

GETList all organization licenses
GETRetrieve an organization license
GETRetrieve a license's feature entitlements
PATCHUpdate an organization license

Organization Activations

GETList all organization activations
GETRetrieve an organization activation

Resellers

GETList all resellers
GETRetrieve a reseller
POSTCreate a reseller
PATCHUpdate a reseller
DELETEDelete a reseller

Reseller Users

GETList all reseller users
GETRetrieve a reseller user
GETExport reseller users
POSTCreate a reseller user
PATCHUpdate a reseller user
DELETEDelete a reseller user

Reseller Organizations

GETList all reseller organizations
GETRetrieve a reseller organization
POSTCreate a reseller organization
PATCHUpdate a reseller organization
DELETEDelete a reseller organization

Reseller Licenses

GETList all reseller licenses
GETRetrieve a reseller license
GETRetrieve a license's feature entitlements
GETExport reseller licenses
POSTRenew reseller license
PATCHUpdate a reseller license
PATCHUpdate reseller license expiration
DELETEDelete a reseller license

Reseller Activations

GETList all reseller activations
GETRetrieve a reseller activation
GETExport reseller activations

GETRetrieve account stats
GETRetrieve licenses' stats
GETRetrieve activations by time
GETRetrieve activations by OS
GETRetrieve activations by OS version
GETRetrieve activations by geo-location
GETRetrieve activations by release version
GETRetrieve activations by virtual machines
GETRetrieve trial activations by time
GETRetrieve trial activations by OS
GETRetrieve trial activations by OS version
GETRetrieve trial activations by geo-location
GETRetrieve trial activations by virtual machines

Webhooks

GETList all webhooks
GETRetrieve a webhook
GETList all events
POSTCreate a webhook
POSTSend a test event
PATCHUpdate a webhook
DELETEDelete a webhook

Webhook Event Logs

GETList all webhook event logs
GETRetrieve a webhook event log
POSTResend the webhook

Automated Emails

GETList all automated emails
GETRetrieve an automated email
GETList all events
POSTCreate an automated email
PATCHUpdate an automated email
DELETEDelete an automated email

Automated Email Event Logs

GETList all automated email event logs
GETRetrieve an automated email event log
POSTResend the automated email mail

GETRetrieve an account
GETGet subscription status
GETDownload organization SAML service provider certificate.
PATCHUpdate an account
PATCHUpdate account custom domains
PUTUpdate account status

GETList all audit logs
GETExport audit logs
GETRetrieve an audit log
GETList all resources

Download the Product Data file

Retrieves the details of an existing product.

GET/v3/products/{id}/product.dat

JWTproduct:read

Path parameters

idstringrequired

Response

200

401

403

404

429

500

200 OK