Seats and Subscription

Retrieve information details on your subscription and its usage accross Talend Apps.

Endpoints

https://api.eu.cloud.talend.com
URL for the AWS Europe region
https://api.ap.cloud.talend.com
URL for the AWS Asia Pacific region
https://api.us.cloud.talend.com
URL for the AWS United States East region
https://api.au.cloud.talend.com
URL for the AWS Australia region
https://api.us-west.cloud.talend.com
URL for the Azure United States West region

Global security

These security schemes apply to the entire API

Public

Security scheme

This scheme can be referenced across the API

Public

Bearer authentification

Bearer authentication
Name	Description

Contains information related to token consumption, engines statuses and seat usages

Object

startDate

Subscription start date

string Required

Example

"2019-09-25"

endDate

Subscription end date

string Required

Example

"2019-09-25"

licenseType

License type

string Required

applications

array of string Required

Datatype details
Type	Description	Attributes and examples
array	Available applications
string	List of applications	Example ["Data Inventory", "Data Preparation", "Data Stewardship", "Pipeline Designer", "Dictionary service", "API Designer / API Tester", "Management Console", "Studio"]

supportLevel

Level of support

string Required

tokensStatus

TokensStatus Required

enginesStatus

array of EngineStatus Required

Datatype details
Type	Description	Attributes and examples
array	Give number of engines used by type
EngineStatus

seats

array of Seat Required

Datatype details
Type	Description	Attributes and examples
array	Seats information by application
Seat

Information about engine status

Object

Name	Description	Type	Attributes and examples
type	Engine type	string Required	Enum RE-GEN1 RE-GEN2 CLOUD DYNAMIC-ENGINE-ENVIRONMENT
consumed	Number of engines used by type	integer Required	FormatINT32

Information about tokens

Object

Name	Description	Type	Attributes and examples
total	Number of token allowed for the account	integer Required	FormatINT32
consumed	Number of token currently consumed by the account	integer Required	FormatINT32

Seat information

Object

Name	Description	Type	Attributes and examples
application	Name of application	string Required	Example ["Data Inventory", "Data Preparation", "Data Stewardship", "Pipeline Designer", "Dictionary service", "API Designer / API Tester", "Management Console", "Studio", "Service Accounts"]
maxUsers	Maximum of users allowed to use the application	integer Required	FormatINT32
currentUsers	Count of users currently using the application	integer Required	FormatINT32

Error response object

Object

Name	Description	Type	Attributes and examples
status	HTTP status code	integer Required	Example 401
message	Info about the error for user	string Optional	Example Forbidden
detail	Info about error for developer.	string Optional	Example Token authorization is required for access
requestId	The unique identification of the request involved with this error	string Optional	Example 16fefb53-035a-4249-af9d-f80a3b47b132