Accounts

Download OpenAPI specification:Download

URL: https://veset.tv/ Terms of Service

Services

Ingest - Library - Channel - Schedule - Playout - Audit - Accounts - Reporting - Monitoring - Configuration - Metrics

Docs

Docs API

Retrieve knowledge base access token

Retrieve knowledge base access token, with location header redirect to knowledge base

query Parameters

redirect

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Announcements

Announcements API

Get announcements

Get system wide announcements

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Save system announcement

Request Body schema: application/json
required

body	string Announcement body
description	string Short description of the announcment
expirationDate	string <date-time> Announcement expiration date, in milliseconds
id	string Announcement id
messageType	string Enum: "ERROR" "WARNING" "INFO" "SUCCESS" "INFO" "WARNING" "ERROR" "SUCCESS" Announcement message type
organizationId	string Organization id
title	string Announcement title
type	string Enum: "BANNER" "MODAL" "BANNER" "MODAL" Announcement type

Responses

Request samples

Payload

Content type

application/json

{"body": "Announcement body",
"description": "Announcement description",
"expirationDate": "10000000",
"messageType": "BANNER",
"organizationId": "5c9e9b0e1c9d440000e1c9d4",
"title": "Announcement title",
"type": "INFO"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get active announcement

Get active system wide announcement

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Delete system announcement

path Parameters

announcementId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Update system announcement

path Parameters

announcementId

required

string

Request Body schema: application/json
required

body	string Announcement body
description	string Short description of the announcment
expirationDate	string <date-time> Announcement expiration date, in milliseconds
id	string Announcement id
messageType	string Enum: "ERROR" "WARNING" "INFO" "SUCCESS" "INFO" "WARNING" "ERROR" "SUCCESS" Announcement message type
organizationId	string Organization id
title	string Announcement title
type	string Enum: "BANNER" "MODAL" "BANNER" "MODAL" Announcement type

Responses

Request samples

Payload

Content type

application/json

{"body": "Announcement body",
"description": "Announcement description",
"expirationDate": "10000000",
"messageType": "BANNER",
"organizationId": "5c9e9b0e1c9d440000e1c9d4",
"title": "Announcement title",
"type": "INFO"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Invoices

Invoices API

Get billing invoices

Return billing invoices that are available for given organization

query Parameters

organization

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"amountDue": "string",
"currency": "string",
"dateDue": "2019-08-24T14:15:22Z",
"documentDate": "2019-08-24T14:15:22Z",
"documentId": "string",
"documentRef": "string",
"documentStatus": "string",
"total": "string"
}
]

Export billing invoice as PDF

path Parameters

documentId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Accounts

Accounts management

Get users by organization

Get users by organization, returns all users of organization

query Parameters

organization

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

["{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n"
]

Create user

Create user, returns created user

query Parameters

organization

required

Array of strings

Request Body schema: application/json
required

accountNonExpired	boolean
accountNonLocked	boolean
adwiseUser	boolean
apiUser	boolean
assignedOrganizations	Array of strings unique
assignedRoles	Array of strings unique Assigned roles
	object (BillingDTO)
cirrusUser	boolean Deprecated
credentialsNonExpired	boolean
currentPassword	string
email required	string
enabled	boolean
expiration	string <date-time>
externalUser	boolean
externalUserId	string
id	string
leadUser	boolean
nimbusUser	boolean
organizationId required	string
password required	string((?=.\d)(?=.[a-z])(?=.*[A-Z]).{8,})
permissions	Array of strings unique Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS"
permittedOrganizations	Array of strings unique
	object (PersonalInfo)
providerId	string
stratusUser	boolean
useSecondaryPassword	boolean
username required	string

Responses

Request samples

Payload

Content type

application/json

"{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n"

Response samples

200
401
403
404
500

Content type

application/json

{ }

Update user

Update user by id, returns updated user

query Parameters

id	string
organization	Array of strings
providerId	string

Request Body schema: application/json
required

accountNonExpired	boolean
accountNonLocked	boolean
adwiseUser	boolean
apiUser	boolean
assignedOrganizations	Array of strings unique
assignedRoles	Array of strings unique Assigned roles
	object (BillingDTO)
cirrusUser	boolean Deprecated
credentialsNonExpired	boolean
currentPassword	string
email required	string
enabled	boolean
expiration	string <date-time>
externalUser	boolean
externalUserId	string
id	string
leadUser	boolean
nimbusUser	boolean
organizationId required	string
password required	string((?=.\d)(?=.[a-z])(?=.*[A-Z]).{8,})
permissions	Array of strings unique Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS"
permittedOrganizations	Array of strings unique
	object (PersonalInfo)
providerId	string
stratusUser	boolean
useSecondaryPassword	boolean
username required	string

Responses

Request samples

Payload

Content type

application/json

"{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n"

Response samples

200
401
403
404
500

Content type

application/json

{ }

Create Adwise AWS Marketplace organization

Request Body schema: application/json
required

	object (AddressInfo)
awsMarketplaceRegistrationId	string
	object (Branding)
required	object (MediaStoreInfo)
name required	string
preloadContent	boolean
productCode	string
termsAndConditionsId	string
	object (NimbusUser) User
userEmail	string

Responses

Request samples

Payload

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceRegistrationId": "string",
"branding": {"logo": "string",
"title": "string"
},
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"preloadContent": true,
"productCode": "string",
"termsAndConditionsId": "string",
"userDetails": "{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n",
"userEmail": "string"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Subscribe to AdWise AWS Marketplace

Subscribe to Adwise AWS Marketplace

path Parameters

serviceProviderId

required

string

query Parameters

required

object

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Create Nimbus AWS Marketplace organization

Request Body schema: application/json
required

	object (AddressInfo)
awsMarketplaceRegistrationId	string
	object (Branding)
required	object (MediaStoreInfo)
name required	string
preloadContent	boolean
productCode	string
termsAndConditionsId	string
	object (NimbusUser) User
userEmail	string

Responses

Request samples

Payload

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceRegistrationId": "string",
"branding": {"logo": "string",
"title": "string"
},
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"preloadContent": true,
"productCode": "string",
"termsAndConditionsId": "string",
"userDetails": "{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n",
"userEmail": "string"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Subscribe to Nimbus AWS Marketplace

path Parameters

serviceProviderId

required

string

query Parameters

required

object

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Create Stratus AWS Marketplace organization

Request Body schema: application/json
required

	object (AddressInfo)
awsMarketplaceRegistrationId	string
	object (Branding)
	Array of objects (CloudConfigurationDTO) unique
required	object (MediaStoreInfo)
name required	string
required	object (OrganizationPlayoutCreate)
productCode	string
termsAndConditionsId	string
	object (NimbusUser) User
userEmail	string

Responses

Request samples

Payload

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceRegistrationId": "string",
"branding": {"logo": "string",
"title": "string"
},
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"playout": {"inputGraphName": "string",
"liveInputUrl": "string",
"outputAddress": "string",
"outputGraphName": "string",
"outputPort": 0,
"playoutId": "string",
"playoutSelection": "CREATE_NEW",
"presetId": "string",
"type": "AWS",
"vmType": "WINDOWS"
},
"productCode": "string",
"termsAndConditionsId": "string",
"userDetails": "{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n",
"userEmail": "string"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Subscribe to Stratus AWS Marketplace

path Parameters

serviceProviderId required	string
presetId required	string

query Parameters

required

object

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Get AWS Marketplace terms and conditions

path Parameters

awsMarketplaceRegistrationId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"body": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"title": "string",
"type": "AWS_MARKETPLACE"
}

Download AWS Marketplace terms and conditions

path Parameters

awsMarketplaceRegistrationId required	string
termsAndConditionsId required	string

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Validate external user

query Parameters

providerId

required

string

Request Body schema: application/json
required

authorizationToken	string
userId	string

Responses

Request samples

Payload

Content type

application/json

{"authorizationToken": "string",
"userId": "string"
}

Response samples

200
401
403
404
500

Content type

application/json

{"status": "OK",
"userName": "string"
}

Send forgot password request

Send forgot password request for user

Request Body schema: application/json
required

username

required

string

Username to reset

Responses

Request samples

Payload

Content type

application/json

{"username": "username-to-reset"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get reset password data

Get reset password data by secret data hash

query Parameters

data

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Reset password

Reset password for user

query Parameters

data

required

string

Request Body schema: application/json
required

newPassword

required

string((?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,})

New user password

Responses

Request samples

Payload

Content type

application/json

{"newPassword": "newPassword1234"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get new user registration

Get new user registration by secret data hash, returns registration data

query Parameters

data

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Register new user

Register new user using secret data hash, returns registered user

query Parameters

data

required

string

Request Body schema: application/json
required

accountNonExpired	boolean
accountNonLocked	boolean
adwiseUser	boolean
apiUser	boolean
assignedOrganizations	Array of strings unique
assignedRoles	Array of strings unique Assigned roles
	object (BillingDTO)
cirrusUser	boolean Deprecated
credentialsNonExpired	boolean
currentPassword	string
email required	string
enabled	boolean
expiration	string <date-time>
externalUser	boolean
externalUserId	string
id	string
leadUser	boolean
nimbusUser	boolean
organizationId required	string
password required	string((?=.\d)(?=.[a-z])(?=.*[A-Z]).{8,})
permissions	Array of strings unique Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS"
permittedOrganizations	Array of strings unique
	object (PersonalInfo)
providerId	string
stratusUser	boolean
useSecondaryPassword	boolean
username required	string

Responses

Request samples

Payload

Content type

application/json

"{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n"

Response samples

200
401
403
404
500

Content type

application/json

"{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n"

Get service provider users

Get service provider users, returns all users of service provider

query Parameters

providerId

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

["{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n"
]

Search users

Search users by organization, providerId

query Parameters

organization	Array of strings Organization Ids
providerId	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

["{\n  \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n  \"username\": \"admin\",\n  \"email\": \"support@veset.tv\",\n  \"password\": \"<REDACTED>\",\n"
]

Verify user

Verify user by secret data hash

query Parameters

data

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Delete user

Delete user by id

path Parameters

userId

required

string

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Change user organization

path Parameters

userId required	string
newOrganization required	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Verify secondary password

Verify secondary password for user

path Parameters

userId

required

string

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
401
403
404
500

Content type

application/json

{ }

Change user service provider

path Parameters

userId required	string
providerId required	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get two factor authentication status

Get two factor authentication status for user

path Parameters

userId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Disable two factor authentication

Disable two factor authentication for user

path Parameters

userId

required

string

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
401
403
404
500

Content type

application/json

{ }

Enable two factor authentication

Enable two factor authentication for user

path Parameters

userId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Verify two factor authentication before enabling

Verify two factor authentication for user, returns backup codes

path Parameters

userId

required

string

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
401
403
404
500

Content type

application/json

{ }

Unlock user

Unlock user by id

path Parameters

userId

required

string

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

NimbusGPT

Chat with NimbusGPT

query Parameters

organizationId

string

Request Body schema: application/json
required

Array

content	string
role	string

Responses

Request samples

Payload

Content type

application/json

[{"content": "string",
"role": "string"
}
]

Response samples

200
401
403
404
500

Content type

application/json

[{"content": "string",
"role": "string"
}
]

Terms and Conditions

Terms and Conditions API

Get all terms and conditions

Responses

Response samples

200

Content type

application/json

[{"body": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"title": "string",
"type": "AWS_MARKETPLACE"
}
]

Create terms and conditions

Request Body schema: application/json
required

body	string
dateCreated	string <date-time>
dateUpdated	string <date-time>
id	string
title required	string
type required	string Enum: "AWS_MARKETPLACE" "SERVICE_PROVIDER" "NIMBUS" "STRATUS"

Responses

Request samples

Payload

Content type

application/json

{"body": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"title": "string",
"type": "AWS_MARKETPLACE"
}

Response samples

200

Content type

application/json

{"body": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"title": "string",
"type": "AWS_MARKETPLACE"
}

Delete terms and conditions

path Parameters

termsAndConditionsId

required

string

Responses

Get terms and conditions by id

path Parameters

termsAndConditionsId

required

string

Responses

Response samples

200

Content type

application/json

{"body": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"title": "string",
"type": "AWS_MARKETPLACE"
}

Update terms and conditions

path Parameters

termsAndConditionsId

required

string

Request Body schema: application/json
required

body	string
dateCreated	string <date-time>
dateUpdated	string <date-time>
id	string
title required	string
type required	string Enum: "AWS_MARKETPLACE" "SERVICE_PROVIDER" "NIMBUS" "STRATUS"

Responses

Request samples

Payload

Content type

application/json

{"body": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"title": "string",
"type": "AWS_MARKETPLACE"
}

Response samples

200

Content type

application/json

{"body": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"title": "string",
"type": "AWS_MARKETPLACE"
}

Download terms and conditions by id

path Parameters

termsAndConditionsId

required

string

Responses

Response samples

200

Content type

application/json

{ }

Token

Token API

Get api tokens

Return api tokens

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"assignedRoles": ["string"
],
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"ingest": true,
"internal": true,
"issued": "2019-08-24T14:15:22Z",
"name": "string",
"organization": "string",
"permissions": ["NOOP"
],
"permittedOrganizations": ["string"
],
"playout": true,
"providerId": "string",
"secretKey": "string",
"superAdmin": true,
"tokenId": "string"
}
]

Generate api token

Return api token

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

assignedRoles	Array of strings unique
expiration	string <date-time>
name	string
permittedOrganizations	Array of strings unique
superAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"assignedRoles": ["string"
],
"expiration": "2019-08-24T14:15:22Z",
"name": "string",
"permittedOrganizations": ["string"
],
"superAdmin": true
}

Response samples

200
401
403
404
500

Content type

application/json

"string"

Generate ingest api token

Return api token

Request Body schema: application/json
required

assignedRoles	Array of strings unique
expiration	string <date-time>
name	string
permittedOrganizations	Array of strings unique
superAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"assignedRoles": ["string"
],
"expiration": "2019-08-24T14:15:22Z",
"name": "string",
"permittedOrganizations": ["string"
],
"superAdmin": true
}

Response samples

200
401
403
404
500

Content type

application/json

"string"

Generate internal api token

Return api token

Request Body schema: application/json
required

assignedRoles	Array of strings unique
expiration	string <date-time>
name	string
permittedOrganizations	Array of strings unique
superAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"assignedRoles": ["string"
],
"expiration": "2019-08-24T14:15:22Z",
"name": "string",
"permittedOrganizations": ["string"
],
"superAdmin": true
}

Response samples

200
401
403
404
500

Content type

application/json

"string"

Generate internal playout token

Return api token

Request Body schema: application/json
required

expiration	string <date-time>
playoutId	string

Responses

Request samples

Payload

Content type

application/json

{"expiration": "2019-08-24T14:15:22Z",
"playoutId": "string"
}

Response samples

200
401
403
404
500

Content type

application/json

"string"

deleteToken

Delete api token

path Parameters

tokenId

required

string

Token id

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Activate api token

path Parameters

tokenId

required

string

Token id

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Deactivate api token

path Parameters

tokenId

required

string

Token id

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Maintenance

Maintenance API

Get all scheduled maintenance events

Responses

Response samples

200
401
403
404
500

Content type

application/json

["{\n  \"description\": \"Maintenance will be performed on 2019-03-30 00:00:00\"\n  \"startDate\": \"10000000\",\n  \"endDate\": \"10000000\"\n}"
]

Schedule new maintenance event

Request Body schema: application/json
required

description	string Maintenance event description
endDate required	string <date-time> Maintenance event end date
id	string Maintenance event id
startDate required	string <date-time> Maintenance event start date

Responses

Request samples

Payload

Content type

application/json

"{\n  \"description\": \"Maintenance will be performed on 2019-03-30 00:00:00\"\n  \"startDate\": \"10000000\",\n  \"endDate\": \"10000000\"\n}"

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get next maintenance event

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Delete maintenance event

path Parameters

eventId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get maintenance event by id

path Parameters

eventId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

"{\n  \"description\": \"Maintenance will be performed on 2019-03-30 00:00:00\"\n  \"startDate\": \"10000000\",\n  \"endDate\": \"10000000\"\n}"

Update maintenance event

path Parameters

eventId

required

string

Request Body schema: application/json
required

description	string Maintenance event description
endDate required	string <date-time> Maintenance event end date
id	string Maintenance event id
startDate required	string <date-time> Maintenance event start date

Responses

Request samples

Payload

Content type

application/json

"{\n  \"description\": \"Maintenance will be performed on 2019-03-30 00:00:00\"\n  \"startDate\": \"10000000\",\n  \"endDate\": \"10000000\"\n}"

Response samples

200
401
403
404
500

Content type

application/json

"{\n  \"description\": \"Maintenance will be performed on 2019-03-30 00:00:00\"\n  \"startDate\": \"10000000\",\n  \"endDate\": \"10000000\"\n}"

Roles

Roles API

Get organization security roles

Return security roles that are available for given organization

query Parameters

providerId	string
organization	Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"organizationId": "string",
"permissions": ["NOOP"
],
"providerId": "string",
"roleName": "string",
"superAdmin": true,
"updated": "2019-08-24T14:15:22Z",
"userCount": 0
}
]

Creates security role

Creates and returns new security role

query Parameters

providerId	string
organization	Array of strings

Request Body schema: application/json
required

created	string <date-time>
description	string
id	string
organizationId	string
permissions	Array of strings unique Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS"
providerId	string
roleName required	string
superAdmin	boolean
updated	string <date-time>
userCount	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"organizationId": "string",
"permissions": ["NOOP"
],
"providerId": "string",
"roleName": "string",
"superAdmin": true,
"updated": "2019-08-24T14:15:22Z",
"userCount": 0
}

Response samples

200
401
403
404
500

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"organizationId": "string",
"permissions": ["NOOP"
],
"providerId": "string",
"roleName": "string",
"superAdmin": true,
"updated": "2019-08-24T14:15:22Z",
"userCount": 0
}

Delete security role

Deletes security role with given role name

path Parameters

roleId

required

string

Role id

query Parameters

providerId	string
organization	Array of strings
superAdmin	boolean

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get security role with given id

Return security role with given id

path Parameters

roleId

required

string

Role id

query Parameters

providerId	string
organization	Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"organizationId": "string",
"permissions": ["NOOP"
],
"providerId": "string",
"roleName": "string",
"superAdmin": true,
"updated": "2019-08-24T14:15:22Z",
"userCount": 0
}

Update security role

Return security role with given role name

path Parameters

roleId

required

string

Role id

query Parameters

providerId	string
organization	Array of strings

Request Body schema: application/json
required

created	string <date-time>
description	string
id	string
organizationId	string
permissions	Array of strings unique Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS"
providerId	string
roleName required	string
superAdmin	boolean
updated	string <date-time>
userCount	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"organizationId": "string",
"permissions": ["NOOP"
],
"providerId": "string",
"roleName": "string",
"superAdmin": true,
"updated": "2019-08-24T14:15:22Z",
"userCount": 0
}

Response samples

200
401
403
404
500

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"organizationId": "string",
"permissions": ["NOOP"
],
"providerId": "string",
"roleName": "string",
"superAdmin": true,
"updated": "2019-08-24T14:15:22Z",
"userCount": 0
}

Jobs

Jobs API

Get job

Returns queued job

path Parameters

jobId

required

string

Job id

query Parameters

providerId	string
organization	Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateFinished": "2019-08-24T14:15:22Z",
"entityId": "string",
"fileName": "string",
"id": "string",
"jobType": "string",
"messages": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Organization

Organization management

Get organizations

Get organizations, filtered by type and include disabled

query Parameters

includeDisabled	boolean Include disabled organizations
type	string Enum: "NIMBUS" "CIRRUS" "STRATUS" "AD_WISE" Organization type
includePermissions	boolean Include organization permission list

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}
]

Create new organization

Create organization

query Parameters

providerId	string
email	string
preload-content	boolean Default: false

Request Body schema: application/json
required

	object (AddressInfo)
awsMarketplaceOrganization	boolean
required	object (Billing)
	object (Branding)
buildAccessEnabled	boolean
	Array of objects (CloudConfigurationDTO) unique
	object (ComplianceRecordingSettingsDTO)
created	string <date-time>
enabled	boolean
	object (ExternalSystem)
id	string
licenseMode	string Enum: "DEMO" "PRODUCTION"
	object (MediaStoreInfo)
name required	string
oldPlayoutNotificationEnabled	boolean
permissions	Array of strings unique Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS"
playoutId	string
	object (ResourceLimitsDTO)
serviceProviderId	string
	object (TermsAndConditionsApproval)
type	string Enum: "NIMBUS" "CIRRUS" "STRATUS" "AD_WISE"

Responses

Request samples

Payload

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Search organizations

Search organizations, filtered by providerId and include disabled

query Parameters

providerId	string
isAwsMarketplace	boolean
enabledOnly	boolean Default: true

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}
]

Get organization

Get organization by id

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}

Update organization

Update organization details

path Parameters

organizationId

required

string

query Parameters

providerId	string
organization	Array of strings

Request Body schema: application/json
required

	object (AddressInfo)
awsMarketplaceOrganization	boolean
required	object (Billing)
	object (Branding)
buildAccessEnabled	boolean
	Array of objects (CloudConfigurationDTO) unique
	object (ComplianceRecordingSettingsDTO)
created	string <date-time>
enabled	boolean
	object (ExternalSystem)
id	string
licenseMode	string Enum: "DEMO" "PRODUCTION"
	object (MediaStoreInfo)
name required	string
oldPlayoutNotificationEnabled	boolean
permissions	Array of strings unique Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS"
playoutId	string
	object (ResourceLimitsDTO)
serviceProviderId	string
	object (TermsAndConditionsApproval)
type	string Enum: "NIMBUS" "CIRRUS" "STRATUS" "AD_WISE"

Responses

Request samples

Payload

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}

Response samples

200
401
403
404
500

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}

Get organization announcements

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"body": "Announcement body",
"description": "Announcement description",
"expirationDate": "10000000",
"messageType": "BANNER",
"organizationId": "5c9e9b0e1c9d440000e1c9d4",
"title": "Announcement title",
"type": "INFO"
}
]

Post organization announcement

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Request Body schema: application/json
required

body	string Announcement body
description	string Short description of the announcment
expirationDate	string <date-time> Announcement expiration date, in milliseconds
id	string Announcement id
messageType	string Enum: "ERROR" "WARNING" "INFO" "SUCCESS" "INFO" "WARNING" "ERROR" "SUCCESS" Announcement message type
organizationId	string Organization id
title	string Announcement title
type	string Enum: "BANNER" "MODAL" "BANNER" "MODAL" Announcement type

Responses

Request samples

Payload

Content type

application/json

{"body": "Announcement body",
"description": "Announcement description",
"expirationDate": "10000000",
"messageType": "BANNER",
"organizationId": "5c9e9b0e1c9d440000e1c9d4",
"title": "Announcement title",
"type": "INFO"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Delete organization announcement

path Parameters

organizationId required	string
announcementId required	string

query Parameters

organization

Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Update organization announcement

path Parameters

organizationId required	string
announcementId required	string

query Parameters

organization

Array of strings

Request Body schema: application/json
required

body	string Announcement body
description	string Short description of the announcment
expirationDate	string <date-time> Announcement expiration date, in milliseconds
id	string Announcement id
messageType	string Enum: "ERROR" "WARNING" "INFO" "SUCCESS" "INFO" "WARNING" "ERROR" "SUCCESS" Announcement message type
organizationId	string Organization id
title	string Announcement title
type	string Enum: "BANNER" "MODAL" "BANNER" "MODAL" Announcement type

Responses

Request samples

Payload

Content type

application/json

{"body": "Announcement body",
"description": "Announcement description",
"expirationDate": "10000000",
"messageType": "BANNER",
"organizationId": "5c9e9b0e1c9d440000e1c9d4",
"title": "Announcement title",
"type": "INFO"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Update organization branding

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Request Body schema: application/json
required

logo	string
title	string

Responses

Request samples

Payload

Content type

application/json

{"logo": "string",
"title": "string"
}

Response samples

200
401
403
404
500

Content type

application/json

{"logo": "string",
"title": "string"
}

Describe available organization permissions

Gets available organization permissions

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"category": "string",
"description": "string",
"id": "string",
"name": "string"
}
]

Request playout for organization

Request playout

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
401
403
404
500

Content type

application/json

{ }

Request support ticket

path Parameters

organizationId

required

string

Request Body schema: application/json
required

email	string
name	string
severity	string Enum: "LOW" "HIGH" "MEDIUM"
text	string
type	string Enum: "INDIVIDUAL" "COMPANY"

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"name": "string",
"severity": "LOW",
"text": "string",
"type": "INDIVIDUAL"
}

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Download organization terms and conditions

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Accept organization terms and conditions

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Decline organization terms and conditions

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get organization type

Get organization type by id

path Parameters

organizationId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"type": "NIMBUS"
}

Get pending invitations

Get pending invitations for organization

path Parameters

organizationId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"adwiseUser": true,
"assignedOrganizations": ["string"
],
"assignedRoles": ["string"
],
"cirrusUser": true,
"email": "string",
"expiration": "2019-08-24T14:15:22Z",
"firstUser": true,
"id": "string",
"nimbusUser": true,
"presetId": "string",
"productCode": "string",
"providerId": "string",
"secret": "string",
"stratusUser": true,
"superAdmin": true
}
]

Invite new user

Invite new user to organization

path Parameters

organizationId

required

string

query Parameters

organization

Array of strings

Request Body schema: application/json
required

adwiseUser	boolean
assignedOrganizations	Array of strings unique
assignedRoles	Array of strings unique
email required	string
nimbusUser	boolean
	object (Role)
stratusUser	boolean

Responses

Request samples

Payload

Content type

application/json

{"adwiseUser": true,
"assignedOrganizations": ["string"
],
"assignedRoles": ["string"
],
"email": "string",
"nimbusUser": true,
"role": {"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"organizationId": "string",
"permissions": ["NOOP"
],
"providerId": "string",
"roleName": "string",
"superAdmin": true,
"updated": "2019-08-24T14:15:22Z",
"userCount": 0
},
"stratusUser": true
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

deleteUserInvitation_1

path Parameters

organizationId required	string
invitationId required	string

query Parameters

organization

Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Delete organization

Delete organization by id

path Parameters

organization

required

string

query Parameters

providerId	string
organization	Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Delete organization

Delete organization by id, requires password

path Parameters

organization

required

string

query Parameters

providerId	string
organization	Array of strings

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
401
403
404
500

Content type

application/json

{ }

Disable organization

Disable organization by id

path Parameters

organization

required

string

query Parameters

organization

Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Enable playout creation

Remove permissions that are required to access the create playout feature

path Parameters

organization

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Enable organization

Enable organization by id

path Parameters

organization

required

string

query Parameters

organization

Array of strings

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Disable playout creation

Add permissions that are required to access the create playout feature

path Parameters

organization

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Validate organization migration

Validates if organization is capable to migrate to new SP

path Parameters

organization

required

string

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
401
403
404
500

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}

Get active sessions

Gets active sessions for organization

path Parameters

organization

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"creationTime": 0,
"lastActivity": 0,
"username": "string"
}
]

Service Providers

Service Providers API

Get service providers

query Parameters

enabled	boolean
exclude	Array of strings Fields to be excluded from result
omitAdditionalResources	boolean Default: true

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"allowedOrganizationTypes": ["NIMBUS"
],
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"createAdwiseOrganization": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizations": [{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": null,
"ipRange": null,
"name": null,
"port": null,
"protocol": null,
"securityGroupId": null,
"toPort": null
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}
],
"permissions": ["NOOP"
],
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
}
}
]

Create service provider

query Parameters

email

string

Request Body schema: application/json
required

	object (AddressInfo)
allowedOrganizationTypes	Array of strings unique Items Enum: "NIMBUS" "CIRRUS" "STRATUS" "AD_WISE"
required	object (Billing)
buildAccessEnabled	boolean
	Array of objects (CloudConfigurationDTO) unique
createAdwiseOrganization	boolean
dateCreated	string <date-time>
dateUpdated	string <date-time>
enabled	boolean
expirationDate	string <date-time>
id	string
name required	string
	Array of objects (Organization)
permissions	Array of strings unique Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS"
	object (TermsAndConditionsApproval)

Responses

Request samples

Payload

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"allowedOrganizationTypes": ["NIMBUS"
],
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"createAdwiseOrganization": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizations": [{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}
],
"permissions": ["NOOP"
],
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
}
}

Response samples

200
401
403
404
500

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"allowedOrganizationTypes": ["NIMBUS"
],
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"createAdwiseOrganization": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizations": [{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}
],
"permissions": ["NOOP"
],
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
}
}

Invite new customer

Request Body schema: application/json
required

	object (AddressInfo)
email required	string
mediaStoreType	string Enum: "S3" "BRIGHTCOVE" "FTP" "SERVERS_COM" "TELIA_S3" "ALIBABA" "S3_GENERIC" "AZURE" "WASABI" "S3_PAIRED" "S3_EXTERNAL" "DOTSTUDIO_PRO"
nimbusUser	boolean
organizationName	string
providerName	string
stratusUser	boolean
type	string Enum: "NIMBUS" "CIRRUS" "STRATUS" "AD_WISE"

Responses

Request samples

Payload

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"email": "string",
"mediaStoreType": "S3",
"nimbusUser": true,
"organizationName": "string",
"providerName": "string",
"stratusUser": true,
"type": "NIMBUS"
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get service provider

path Parameters

providerId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"allowedOrganizationTypes": ["NIMBUS"
],
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"createAdwiseOrganization": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizations": [{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}
],
"permissions": ["NOOP"
],
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
}
}

Update service provider

Update service provider details

path Parameters

providerId

required

string

Request Body schema: application/json
required

	object (AddressInfo)
allowedOrganizationTypes	Array of strings unique Items Enum: "NIMBUS" "CIRRUS" "STRATUS" "AD_WISE"
required	object (Billing)
buildAccessEnabled	boolean
	Array of objects (CloudConfigurationDTO) unique
createAdwiseOrganization	boolean
dateCreated	string <date-time>
dateUpdated	string <date-time>
enabled	boolean
expirationDate	string <date-time>
id	string
name required	string
	Array of objects (Organization)
permissions	Array of strings unique Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS"
	object (TermsAndConditionsApproval)

Responses

Request samples

Payload

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"allowedOrganizationTypes": ["NIMBUS"
],
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"createAdwiseOrganization": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizations": [{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}
],
"permissions": ["NOOP"
],
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
}
}

Response samples

200
401
403
404
500

Content type

application/json

{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"allowedOrganizationTypes": ["NIMBUS"
],
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"createAdwiseOrganization": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizations": [{"addressInfo": {"address": "string",
"city": "string",
"country": "string",
"phoneNumber": "string",
"zipCode": "string"
},
"awsMarketplaceOrganization": true,
"billing": {"automaticMode": true,
"automaticThresholds": [{"days": 0,
"settings": {"limitations": ["READONLY_USERS"
],
"message": "string",
"status": "OK"
}
}
],
"limitations": ["READONLY_USERS"
],
"message": "string",
"paytraqClientId": "string",
"status": "OK"
},
"branding": {"logo": "string",
"title": "string"
},
"buildAccessEnabled": true,
"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true
},
"created": "2019-08-24T14:15:22Z",
"enabled": true,
"externalSystem": {"redirectUrl": "string",
"title": "string",
"userAuthorizationUrl": "string",
"userId": "string",
"userName": "string"
},
"id": "string",
"licenseMode": "DEMO",
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"oldPlayoutNotificationEnabled": true,
"permissions": ["NOOP"
],
"playoutId": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
},
"type": "NIMBUS"
}
],
"permissions": ["NOOP"
],
"termsAndConditions": {"approved": true,
"dateApproved": "2019-08-24T14:15:22Z",
"termsAndConditionsId": "string"
}
}

Delete service provider

path Parameters

providerId

required

string

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200
401
403
404
500

Content type

application/json

{ }

Get service provider permission descriptions

path Parameters

providerId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"category": "string",
"description": "string",
"id": "string",
"name": "string"
}
]

Disable service provider

path Parameters

providerId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Disable playout creation

Add permissions that are required to access the create playout feature

path Parameters

providerId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Enable service provider

path Parameters

providerId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Enable playout creation

Remove permissions that are required to access the create playout feature

path Parameters

providerId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Invite new user

path Parameters

providerId

required

string

Request Body schema: application/json
required

adwiseUser	boolean
assignedOrganizations	Array of strings unique
assignedRoles	Array of strings unique
email required	string
nimbusUser	boolean
	object (Role)
stratusUser	boolean

Responses

Request samples

Payload

Content type

application/json

{"adwiseUser": true,
"assignedOrganizations": ["string"
],
"assignedRoles": ["string"
],
"email": "string",
"nimbusUser": true,
"role": {"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"organizationId": "string",
"permissions": ["NOOP"
],
"providerId": "string",
"roleName": "string",
"superAdmin": true,
"updated": "2019-08-24T14:15:22Z",
"userCount": 0
},
"stratusUser": true
}

Response samples

200
401
403
404
500

Content type

application/json

{ }

deleteUserInvitation

path Parameters

providerId required	string
invitationId required	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Download service provider terms and conditions

path Parameters

providerId

required

string

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Accept service provider terms and conditions

path Parameters

providerId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Decline service provider terms and conditions

path Parameters

providerId

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{ }

Accounts

Services

Docs

Retrieve knowledge base access token

query Parameters

Responses

Response samples

Announcements

Get announcements

Responses

Response samples

Save system announcement

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get active announcement

Responses

Response samples

Delete system announcement

path Parameters

Responses

Response samples

Update system announcement

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Invoices

Get billing invoices

query Parameters

Responses

Response samples

Export billing invoice as PDF

path Parameters

Responses

Response samples

Accounts

Get users by organization

query Parameters

Responses

Response samples

Create user

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update user

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create Adwise AWS Marketplace organization

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Subscribe to AdWise AWS Marketplace

path Parameters

query Parameters

Responses

Response samples

Create Nimbus AWS Marketplace organization

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Subscribe to Nimbus AWS Marketplace

path Parameters

query Parameters

Responses

Response samples

Create Stratus AWS Marketplace organization

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required