{ "openapi": "3.0.1", "info": { "title": "Haivision Hub API", "description": "Haivision Hub API", "contact": { "name": "Haivision Hub Support", "url": "https://www.haivision.com", "email": "srthub@haivision.com" }, "version": "Version: 2.8.2.0, Date: 2/2/2024 5:05:50 PM" }, "paths": { "/organizations/{organizationId}/subscriptions/{subscriptionId}/bulk/hublet-routes/create": { "post": { "tags": [ "BulkHubletRoute" ], "summary": "Create Hublet Routes in Bulk", "description": "Creates Hublet Routes in bulk. This method receives a csv file with the information of the Hublet Routes that will be created.<br/><br/>[security] Required role action(s): HubletsRoutesCreate", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkHubletRouteManagementInformationBulkOperationResult" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesCreate" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/bulk/hublet-routes/start": { "post": { "tags": [ "BulkHubletRoute" ], "summary": "Start Hublet Routes in Bulk", "description": "Starts extisting Hublet Routes in bulk. This method receives a csv file with the information of the Hublet Routes that will be started.<br/><br/>[security] Required role action(s): HubletsRoutesStart", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkHubletRouteManagementInformationBulkOperationResult" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesStart" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/bulk/hublet-routes/stop": { "post": { "tags": [ "BulkHubletRoute" ], "summary": "Stop Hublet Routes in Bulk", "description": "Stops existing Hublet Routes in bulk. This method receives a csv file with the information of the Hublet Routes that will be stopped.<br/><br/>[security] Required role action(s): HubletsRoutesStop", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkHubletRouteManagementInformationBulkOperationResult" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesStop" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/bulk/hublet-routes/update": { "post": { "tags": [ "BulkHubletRoute" ], "summary": "Update Hublet Routes in Bulk", "description": "Updates existing Hublet Routes in bulk. This method receives a csv file with the updated information of the Hublet Routes that already exist.<br/><br/>[security] Required role action(s): HubletsRoutesUpdate", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkHubletRouteManagementInformationBulkOperationResult" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesUpdate" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/bulk/hublet-routes/delete": { "post": { "tags": [ "BulkHubletRoute" ], "summary": "Delete Hublet Routes in Bulk", "description": "Deletes existing Hublet Routes in bulk. This method receives a csv file with the information of the Hublet Routes that will be deleted.<br/><br/>[security] Required role action(s): HubletsRoutesDelete", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkHubletRouteManagementInformationBulkOperationResult" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesDelete" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/bulk/hublet-routes/info": { "post": { "tags": [ "BulkHubletRoute" ], "summary": "Get Hublet Routes in Bulk", "description": "Gets Hublet Routes details in bulk. This method receives a csv file with the information of the Hublet Routes that will be retrieved.<br/><br/>[security] Required role action(s): HubletsRoutesGet", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkHubletRouteManagementInformationBulkOperationResult" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGet" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/client-credentials": { "post": { "tags": [ "ClientCredentials" ], "summary": "Registers client credentials for Haivision Hub API access under the scope of a subscription.", "description": "ClientId should be obtained from an Azure AD application manually created under the B2C tenant of current environment.<br/><br/>[security] Required role action(s): ClientCredentialsRegister", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: c36f5a7a-2x12-4dn3-abn0-cx2466410a23", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ClientCredentialsRequestPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientCredentialsRequestPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientCredentialsRequestPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClientCredentialsRequestPayload" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDTO" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ClientCredentialsRegister" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/client-credentials/{clientId}": { "delete": { "tags": [ "ClientCredentials" ], "summary": "Unregisters client credentials for Haivision Hub API access under the scope of a subscription.", "description": "ClientId should be obtained from an Azure AD application manually created under the B2C tenant of current environment.<br/><br/>[security] Required role action(s): ClientCredentialsUnregister", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: c36f5a7a-2x12-4dn3-abn0-cx2466410a23", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "path", "description": "Id of the Client Credential to be removed", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ClientCredentialsUnregister" ] } ] } }, "/token": { "post": { "tags": [ "ClientCredentials" ], "summary": "Acquires a Sancus token for authenticating with the API. Only client credentials (server-to-server flow) allowed for the moment.", "description": "ClientId and ClientSecret should be provided by Haivision support.<br/><br/>[security] Allow anonymous access", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccessTokenPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccessTokenPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessTokenPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccessTokenPayload" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessTokenResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{hubletRouteId}/containers/logs": { "get": { "tags": [ "Containers" ], "summary": "Get Container Logs", "description": "<br/><br/>[security] Required role action(s): HubletsRoutesStart", "parameters": [ { "name": "hubletRouteId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponseMessage" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "HubletsRoutesStart" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/wowza/validate": { "post": { "tags": [ "CustomHublets" ], "summary": "Validates against Wowza API if the connection code received is valid", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WowzaConnectionCodePayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WowzaConnectionCodePayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WowzaConnectionCodePayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WowzaConnectionCodePayload" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WowzaValidationResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/external-hublets": { "post": { "tags": [ "ExternalHublets" ], "summary": "Register External Hublet", "description": "Registers a new External Hublet with the payload information in the subscription with the given Id.<br/><br/>[security] Required role action(s): ExternalHubletsRegister", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ExternalHubletRegistrationRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletRegistrationRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletRegistrationRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalHubletRegistrationRequestDTO" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ExternalHubletsRegister" ] } ] }, "get": { "tags": [ "ExternalHublets" ], "summary": "Get all External Hublets", "description": "Gets all the External Hublets available for the user.<br/><br/>[security] Required role action(s): ExternalHubletsGet", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalHubletDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ExternalHubletsGet" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/external-hublets/factories": { "post": { "tags": [ "ExternalHublets" ], "description": "<br/><br/>[security] Required role action(s): ExternalHubletsGetFactories", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FactoryListDTO" } } } } }, "502": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ExternalHubletsGetFactories" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/external-hublets/factories/{factoryId}/config-templates": { "post": { "tags": [ "ExternalHublets" ], "description": "<br/><br/>[security] Required role action(s): ExternalHubletsGetConfigurations", "parameters": [ { "name": "factoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigListDTO" } } } } }, "502": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ExternalHubletsGetConfigurations" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/external-hublets/factories/{factoryId}/config-templates/{configId}": { "post": { "tags": [ "ExternalHublets" ], "description": "<br/><br/>[security] Required role action(s): ExternalHubletsGetHubletDefinition", "parameters": [ { "name": "factoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalHubletServiceRequestDTO" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletDefinition" } } } }, "502": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ExternalHubletsGetHubletDefinition" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/external-hublets/{externalHubletId}": { "delete": { "tags": [ "ExternalHublets" ], "summary": "Remove External Hublet", "description": "Removes the External Hublet with the given Id from the subscription with the given Id.<br/><br/>[security] Required role action(s): ExternalHubletsDelete", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "externalHubletId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ExternalHubletsDelete" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/external-hublets/{externalHubletId}/disable": { "put": { "tags": [ "ExternalHublets" ], "summary": "Disable the ExternalHublet with the given Id", "description": "Disables the External Hublet with the given Id.<br/><br/>[security] Required role action(s): ExternalHubletsDisable", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "externalHubletId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ExternalHubletsDisable" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/external-hublets/{externalHubletId}/enable": { "put": { "tags": [ "ExternalHublets" ], "summary": "Enable ExternalHublet", "description": "Enables the External Hublet with the given Id.<br/><br/>[security] Required role action(s): ExternalHubletsEnable", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "externalHubletId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalHubletDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "ExternalHubletsEnable" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/features": { "get": { "tags": [ "FeatureFlags" ], "summary": "Get all Feature Flags", "description": "Gets all the enabled feature flags for the given user, subscription and organization.<br/><br/>[security] Required role action(s): FeatureFlagsGet", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "oauth2": [ "FeatureFlagsGet" ] } ] } }, "/languages/{language}": { "post": { "tags": [ "Help" ], "summary": "Save Preferred Language", "parameters": [ { "name": "language", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" } }, "deprecated": true } }, "/languages": { "get": { "tags": [ "Help" ], "summary": "Get Preferred Language", "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } }, "deprecated": true } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublet-definitions": { "get": { "tags": [ "HubletDefinitions" ], "summary": "Get all Hublet Definitions", "description": "Gets all the Hublet Definitions enabled for the user.<br/><br/>[security] Required role action(s): HubletDefinitionsGet", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HubletDefinitionDTO" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "oauth2": [ "HubletDefinitionsGet" ] } ] }, "post": { "tags": [ "HubletDefinitions" ], "summary": "Register a new Hublet Definition. Requires feature to be enabled on your subscription", "description": "<br/><br/>[security] Required role action(s): OlympiaHubletsRegister", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OlympiaHubletRegistrationRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OlympiaHubletRegistrationRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OlympiaHubletRegistrationRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OlympiaHubletRegistrationRequestDTO" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletDefinitionDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "oauth2": [ "OlympiaHubletsRegister" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublet-definitions/{hubletDefinitionId}": { "get": { "tags": [ "HubletDefinitions" ], "summary": "Get Hublet Definition", "description": "Gets the details of the Hublet Definition with the given Id.<br/><br/>[security] Required role action(s): HubletDefinitionsGet", "parameters": [ { "name": "hubletDefinitionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletDefinitionDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "oauth2": [ "HubletDefinitionsGet" ] } ] }, "delete": { "tags": [ "HubletDefinitions" ], "summary": "DeRegister a Hublet Definition . Requires feature to be enabled on your subscription", "description": "<br/><br/>[security] Required role action(s): OlympiaHubletsRegister", "parameters": [ { "name": "hubletDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalHubletDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "oauth2": [ "OlympiaHubletsRegister" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/telemetry/days": { "get": { "tags": [ "HubletHistoricalData" ], "summary": "Get subscription's historical data grouped by day", "description": "Gets the subscription's historical data for the current subscription from the last amount of days indicated in \"range\" parameter, grouped by day.<br/><br/>[security] Required role action(s): HubletsRoutesGetTelemetry", "parameters": [ { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 30 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryByBandwidthDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGetTelemetry" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/telemetry/hours": { "get": { "tags": [ "HubletHistoricalData" ], "summary": "Get subscription's historical data grouped by hours", "description": "Gets the subscription's historical data for the current subscription from the last amount of hours indicated in \"range\" parameter, grouped by hours.<br/><br/>[security] Required role action(s): HubletsRoutesGetTelemetry", "parameters": [ { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 24 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryByBandwidthDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGetTelemetry" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/containers/{containerId}/telemetry/days": { "get": { "tags": [ "HubletHistoricalData" ], "summary": "Get container's historical data grouped by day", "description": "Gets the container's historical data with the given containerId from the last amount of days indicated in \"range\" parameter, grouped by day.<br/><br/>[security] Required role action(s): HubletsRoutesGetTelemetry", "parameters": [ { "name": "containerId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 30 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryByBandwidthDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGetTelemetry" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/containers/{containerId}/telemetry/hours": { "get": { "tags": [ "HubletHistoricalData" ], "summary": "Get container's historical data grouped by hour", "description": "Gets the container's historical data with the given containerId from the last amount of hours indicated in \"range\" parameter, grouped by hour.<br/><br/>[security] Required role action(s): HubletsRoutesGetTelemetry", "parameters": [ { "name": "containerId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 24 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryByBandwidthDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGetTelemetry" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{routeId}/telemetry/days": { "get": { "tags": [ "HubletHistoricalData" ], "summary": "Get route's historical data grouped by day", "description": "Gets the route's historical data with the given routeId from the last amount of days indicated in \"range\" parameter, grouped by day.<br/><br/>[security] Required role action(s): HubletsRoutesGetTelemetry", "parameters": [ { "name": "routeId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 30 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryByBandwidthDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGetTelemetry" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{routeId}/telemetry/hours": { "get": { "tags": [ "HubletHistoricalData" ], "summary": "Get route's historical data grouped by hour", "description": "Gets the route's historical data with the given routeId from the last amount of hours indicated in \"range\" parameter, grouped by hour.<br/><br/>[security] Required role action(s): HubletsRoutesGetTelemetry", "parameters": [ { "name": "routeId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 24 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryByBandwidthDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGetTelemetry" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes": { "get": { "tags": [ "Hublets" ], "summary": "Get Hublets Routes", "description": "Gets the list of Hublet Routes for the given querystring parameters.<br/><br/>[security] Required role action(s): HubletsRoutesGet", "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "alternateId", "in": "query", "schema": { "type": "string" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "NextPageToken", "in": "query", "schema": { "type": "string" } }, { "name": "active", "in": "query", "schema": { "type": "boolean" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletRouteDTOPagedResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGet" ] } ] }, "post": { "tags": [ "Hublets" ], "summary": "Create Hublet Route", "description": "Creates a Hublet Route with the given payload.<br/><br/>[security] Required role action(s): HubletsRoutesCreate", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUpdateHubletRouteRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUpdateHubletRouteRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUpdateHubletRouteRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUpdateHubletRouteRequestDTO" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletRouteDTO" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesCreate" ] } ] }, "delete": { "tags": [ "Hublets" ], "summary": "Delete Hublet Routes", "description": "Deletes the Hublet Routes with the given Ids.<br/><br/>[security] Required role action(s): HubletsRoutesDelete", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "HubletsRoutesDelete" ] } ] } }, "/subscriptions/{subscriptionId}/hublets/routes": { "get": { "tags": [ "Hublets" ], "summary": "Get Hublets Routes by subscriptionId", "description": "Gets the list of Hublet Routes by subscriptionId.<br/><br/>[security] Required role action(s): HubletsRoutesGet", "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "alternateId", "in": "query", "schema": { "type": "string" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "NextPageToken", "in": "query", "schema": { "type": "string" } }, { "name": "active", "in": "query", "schema": { "type": "boolean" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletRouteDTOPagedResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGet" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{hubletRouteId}/hublets": { "post": { "tags": [ "Hublets" ], "summary": "Adds a Hublet to a running Route", "description": "Adds a new Hublet to an existing Route with the given payload.<br/><br/>[security] Required role action(s): HubletsRoutesUpdate", "parameters": [ { "name": "hubletRouteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddHubletRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddHubletRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddHubletRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddHubletRequestDTO" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletRouteDTO" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesUpdate" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{hubletRouteId}/hublets/{hubletId}": { "delete": { "tags": [ "Hublets" ], "summary": "Removes a Hublet to a running Route", "description": "Removes a Hublet from an existing Route.<br/><br/>[security] Required role action(s): HubletsRoutesUpdate", "parameters": [ { "name": "hubletRouteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hubletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletRouteDTO" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesUpdate" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{hubletRouteId}/start": { "post": { "tags": [ "Hublets" ], "summary": "Start Hublet Route", "description": "Triggers the provisioning process of the Hublet Route with the given Id. The provisioning process is a long-running task that is processed asynchronously. You can check the status of the Hublet Route by calling the 'Get Hublet Route' endpoint.<br/><br/>[security] Required role action(s): HubletsRoutesStart", "parameters": [ { "name": "hubletRouteId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletRouteDTO" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesStart" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{hubletRouteId}/stop": { "post": { "tags": [ "Hublets" ], "summary": "Stops Hublet Route", "description": "Triggers the deprovisioning process of the Hublet Route with the given Id. The deprovisioning process is a long-running task that is processed asynchronously. You can check the status of the Hublet Route by calling the 'Get Hublet Route' endpoint. DeleteRouteOnStop parameter specifies whether the route will be deleted after being stopped or not.<br/><br/>[security] Required role action(s): HubletsRoutesStop", "parameters": [ { "name": "hubletRouteId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "202": { "description": "Accepted" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesStop" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/start": { "post": { "tags": [ "Hublets" ], "summary": "Starts all the selected routes", "description": "Triggers the provisioning of the Hublet Routes with the given Ids. The provisioning process is a long-running task that is processed asynchronously. You can check the status of each Hublet Route separately by calling the 'Get Hublet Route' endpoint.<br/><br/>[security] Required role action(s): HubletsRoutesStart", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "202": { "description": "Accepted" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesStart" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/stop": { "post": { "tags": [ "Hublets" ], "summary": "Stop Hublet Routes", "description": "Triggers the deprovisioning process of the Hublet Route with the given Ids. The deprovisioning process is a long-running task that is processed asynchronously. You can check the status of each Hublet Route separately by calling the 'Get Hublet Route' endpoint.<br/><br/>[security] Required role action(s): HubletsRoutesStop", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "202": { "description": "Accepted" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesStop" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/delete": { "post": { "tags": [ "Hublets" ], "summary": "Delete Hublet Routes", "description": "Deletes the Hublet Routes with the given Ids.<br/><br/>[security] Required role action(s): HubletsRoutesDelete", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesDelete" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{hubletRouteId}": { "put": { "tags": [ "Hublets" ], "summary": "Update Hublet Route", "description": "Updates a Hublet Route with the given payload.<br/><br/>[security] Required role action(s): HubletsRoutesUpdate", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hubletRouteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUpdateHubletRouteRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUpdateHubletRouteRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUpdateHubletRouteRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUpdateHubletRouteRequestDTO" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletRouteDTO" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesUpdate" ] } ] }, "delete": { "tags": [ "Hublets" ], "summary": "Delete a Hublet Routes", "description": "Deletes the Hublet Route with the given Id.<br/><br/>[security] Required role action(s): HubletsRoutesDelete", "parameters": [ { "name": "hubletRouteId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesDelete" ] } ] }, "get": { "tags": [ "Hublets" ], "summary": "Get Hublet Route", "description": "Gets the details of the Hublet Route with the given Id.<br/><br/>[security] Required role action(s): HubletsRoutesGet", "parameters": [ { "name": "hubletRouteId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletRouteDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGet" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{hubletRouteId}/errors": { "get": { "tags": [ "Hublets" ], "summary": "Get Hublet Route Errors", "description": "Gets the errors of a Route with the given Id. These errors are associated with all the route runs within a datetime range. If no datetime range is provided, the response will include just the errors from the last route run.<br/><br/>[security] Required role action(s): HubletsRoutesGet", "parameters": [ { "name": "hubletRouteId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "The UTC value to indicate the start of the period\r\nPattern: YYYY-MM-DDTHH:mm:SS\r\nExample value: 2020-01-20T08:01:00", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "The UTC value to indicate the end of the period\r\nPattern: YYYY-MM-DDTHH:mm:SS\r\nExample value: 2020-01-27T16:10:00", "schema": { "type": "string", "format": "date-time" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteErrorDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGet" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/start-times": { "get": { "tags": [ "Hublets" ], "summary": "Get Hublet Route Start times", "description": "Gets the routes start time between a time range.<br/><br/>[security] Required role action(s): HubletsRoutesGet", "parameters": [ { "name": "from", "in": "query", "description": "The value to indicate the start of the period\r\nPattern: YYYY-MM-DD\r\nExample value: 2020-01-20", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "The value to indicate the end of the period\r\nPattern: YYYY-MM-DD\r\nExample value: 2020-01-27", "schema": { "type": "string", "format": "date-time" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubletRouteStartTimeDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGet" ] } ] } }, "/organizations/{organizationId}/hublets/routes/start-times": { "get": { "tags": [ "Hublets" ], "summary": "Get Subscription Hublet Route Start times", "description": "Gets the subscriptions routes start time between a time range.<br/><br/>[security] Required role action(s): HubletsRoutesGet", "parameters": [ { "name": "subscriptionIds", "in": "query", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "from", "in": "query", "description": "The value to indicate the start of the period\r\nPattern: YYYY-MM-DD\r\nExample value: 2020-01-20", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "The value to indicate the end of the period\r\nPattern: YYYY-MM-DD\r\nExample value: 2020-01-27", "schema": { "type": "string", "format": "date-time" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionHubletRouteStartTimes" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGet" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/telemetry": { "get": { "tags": [ "Hublets" ], "summary": "Get Hublet Routes Telemetry", "description": "Gets the telemetry of the Hublet Routes of the subscription.<br/><br/>[security] Required role action(s): HubletsRoutesGetTelemetry", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteTelemetryDTO" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGetTelemetry" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{hubletRouteId}/telemetry": { "get": { "tags": [ "Hublets" ], "summary": "Get Hublet Route Telemetry", "description": "Gets the telemetry of the Hublet Route with the given Id.<br/><br/>[security] Required role action(s): HubletsRoutesGetTelemetry", "parameters": [ { "name": "hubletRouteId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteTelemetryDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "HubletsRoutesGetTelemetry" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/streaming/status/days": { "get": { "tags": [ "HubletStreamingStatus" ], "summary": "Get subscription's telemetry grouped by day", "description": "Gets the subscription's information related to streaming status telemetry for the current subscription from the last amount of days indicated in \"range\" parameter, grouped by day.<br/><br/>[security] Required role action(s): SubscriptionUsage", "parameters": [ { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 30 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HubletStreamingStatusDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/streaming/status/hours": { "get": { "tags": [ "HubletStreamingStatus" ], "summary": "Get subscription's telemetry grouped by hour", "description": "Gets the subscription's information related to streaming status telemetry for the current subscription from the last amount of hours indicated in \"range\" parameter, grouped by hour.<br/><br/>[security] Required role action(s): SubscriptionUsage", "parameters": [ { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 24 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HubletStreamingStatusDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/containers/{containerId}/streaming/status/days": { "get": { "tags": [ "HubletStreamingStatus" ], "summary": "Get container's telemetry grouped by day", "description": "Gets the container's information related to streaming status telemetry with the given containerId from the last amount of days indicated in \"range\" parameter, grouped by day.<br/><br/>[security] Required role action(s): SubscriptionUsage", "parameters": [ { "name": "containerId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 30 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HubletStreamingStatusDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/containers/{containerId}/streaming/status/hours": { "get": { "tags": [ "HubletStreamingStatus" ], "summary": "Get container's telemetry grouped by hour", "description": "Gets the container's information related to streaming status telemetry with the given containerId from the last amount of hours indicated in \"range\" parameter, grouped by hour.<br/><br/>[security] Required role action(s): SubscriptionUsage", "parameters": [ { "name": "containerId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 24 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HubletStreamingStatusDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{routeId}/streaming/status/days": { "get": { "tags": [ "HubletStreamingStatus" ], "summary": "Get route's telemetry grouped by day", "description": "Gets the route's information related to streaming status telemetry with the given routeId from the last amount of days indicated in \"range\" parameter, grouped by day.<br/><br/>[security] Required role action(s): SubscriptionUsage", "parameters": [ { "name": "routeId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 30 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HubletStreamingStatusDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/hublets/routes/{routeId}/streaming/status/hours": { "get": { "tags": [ "HubletStreamingStatus" ], "summary": "Get route's telemetry grouped by hour", "description": "Gets the route's information related to streaming status telemetry with the given routeId from the last amount of hours indicated in \"range\" parameter, grouped by hour.<br/><br/>[security] Required role action(s): SubscriptionUsage", "parameters": [ { "name": "routeId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 24 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HubletStreamingStatusDTO" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionUsage" ] } ] } }, "/notifications/negotiate": { "post": { "tags": [ "Negotiate" ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/notifications/unsubscribe": { "post": { "tags": [ "Negotiate" ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/notifications": { "get": { "tags": [ "Notifications" ], "summary": "Get User Notifications", "description": "Gets the list of notifications for the user.", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "NextPageToken", "in": "query", "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistedNotificationDTOPagedResult" } } } } } }, "put": { "tags": [ "Notifications" ], "summary": "Mark User Notifications as Read", "description": "Marks all the user notifications as read.", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "204": { "description": "No Content" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "deprecated": true }, "delete": { "tags": [ "Notifications" ], "summary": "Delete User Notifications", "description": "Deletes the notifications with the given Ids for the user.", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "204": { "description": "No Content" } }, "deprecated": true } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/notifications/count": { "get": { "tags": [ "Notifications" ], "summary": "Get User Notifications Count", "description": "Gets the notifications count for the user.", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/notifications/mark-as-read": { "post": { "tags": [ "Notifications" ], "summary": "Mark User Notifications as Read", "description": "Marks all the user notifications as read.", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of notification ids to mark as read", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "204": { "description": "No Content" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/notifications/delete": { "post": { "tags": [ "Notifications" ], "summary": "Delete User Notifications", "description": "Deletes the notifications with the given Ids for the user.", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of notification ids to be removed", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "204": { "description": "No Content" } } } }, "/profile": { "get": { "tags": [ "Onboarding" ], "summary": "Gets user profile", "description": "Gets user profile including organization, joined subscriptions and roles assigned to them. A 404 error response is returned when user has not signed up yet. Call /signup endpoint to sign up first.", "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Users" ], "summary": "Update User", "description": "Updates the information of the User with the given payload.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateUserPreferencesRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPreferencesRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPreferencesRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserPreferencesRequestDTO" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDTO" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/profile/other-identities": { "get": { "tags": [ "Onboarding" ], "summary": "Gets user's additional identities", "description": "", "parameters": [ { "name": "includeIdentitiesWithoutSubscriptions", "in": "query", "description": "Indicates whether the result should include identities without subscriptions associated", "schema": { "type": "boolean" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserIdentity" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/signup": { "post": { "tags": [ "Onboarding" ], "summary": "Sign Up User", "description": "Registers the user in Haivision Hub. If using Office 365 SSO, just a valid bearer token should be sent with the request in order to sign up.", "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDTO" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/organizations": { "get": { "tags": [ "Organizations" ], "summary": "Get all organizations", "description": "<br/><br/>[security] Required role action(s): OrganizationsGet", "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationAuthorizationDTO" } } } } } }, "security": [ { "oauth2": [ "OrganizationsGet" ] } ] }, "post": { "tags": [ "Organizations" ], "summary": "Create an organization with the given payload", "description": "<br/><br/>[security] Required role action(s): OrganizationsCreate", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationPayload" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "OrganizationsCreate" ] } ] } }, "/validate-claim-code": { "post": { "tags": [ "PreSubscriptions" ], "summary": "Redeems the subscription by the given claim code.", "description": "Validate the given claim code", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ClaimCodeActivationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClaimCodeActivationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClaimCodeActivationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClaimCodeActivationRequest" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/regions": { "get": { "tags": [ "Regions" ], "summary": "Get Supported Azure Regions", "description": "Gets all the Azure Regions supported by Haivision Hub.<br/><br/>[security] Required role action(s): HubletDefinitionsGet", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegionItem" } } } } } }, "security": [ { "oauth2": [ "HubletDefinitionsGet" ] } ] } }, "/roles": { "get": { "tags": [ "Roles" ], "summary": "Get App Roles", "description": "Gets all the roles available to use in the app.", "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDTO" } } } } } } } }, "/reports/route-telemetry-disconnections": { "get": { "tags": [ "RouteTelemetryDisconnectionsReport" ], "summary": "Get topology telemetry disconnections", "description": "<br/><br/>[security] Required role action(s): RouteTelemetryDisconnectionsReportGet", "parameters": [ { "name": "startDate", "in": "query", "description": "The value to indicate the start of the period\r\nPattern: YYYY-MM-DD\r\nExample value: 2020-01-20", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "The value to indicate the end of the period\r\nPattern: YYYY-MM-DD\r\nExample value: 2020-01-27", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "RouteTelemetryDisconnectionsReportGet" ] } ] } }, "/organizations/{organizationId}/subscriptions": { "get": { "tags": [ "Subscriptions" ], "summary": "Get All Subscriptions by OrganizationId", "description": "Gets all the subcriptions in a given organizationId. This endpoint will only return subscriptions in which the user has a role assigned with the SubscriptionsGet action.", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionDTO" } } } } } } } }, "/admin/subscriptions": { "get": { "tags": [ "Subscriptions" ], "summary": "Get All Subscriptions where the user has admin privileges", "description": "This endpoint will only return subscriptions in which the user has a role assigned with the SubscriptionsGet action.\r\nUsage data is available in organizations/{organizationId}/subscriptions/{subscriptionId}/usage", "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionDTO" } } } } } } } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/deactivate": { "put": { "tags": [ "Subscriptions" ], "summary": "Deactivate subscription", "description": "Deactivates a subscription and stops their running resources<br/><br/>[security] Required role action(s): SubscriptionDeactivate", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionDeactivate" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/activate": { "put": { "tags": [ "Subscriptions" ], "summary": "Activate subscription", "description": "Activate a subscription<br/><br/>[security] Required role action(s): SubscriptionActivate", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionActivate" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}": { "get": { "tags": [ "Subscriptions" ], "summary": "Get Subscription", "description": "Gets the details of a subscription.<br/><br/>[security] Required role action(s): SubscriptionsGet", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionsGet" ] } ] }, "delete": { "tags": [ "Subscriptions" ], "summary": "Delete Subscription", "description": "Deletes the subscription with the given Id and all the resources associated to it.<br/><br/>[security] Required role action(s): SubscriptionsDelete", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionsDelete" ] } ] }, "put": { "tags": [ "Subscriptions" ], "summary": "Update Subscription", "description": "Updates the details of a subscription with the given Id based on the payload.<br/><br/>[security] Required role action(s): SubscriptionsUpdate", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionPayload" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionsUpdate" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/pending-invitations": { "get": { "tags": [ "Subscriptions" ], "summary": "Get Pending User Invitations", "description": "Gets the pending User Invitations of a subscription.<br/><br/>[security] Required role action(s): SubscriptionPendingInvitations", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserInvitationDTO" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionPendingInvitations" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/pending-invitations/{invitationId}/cancel": { "post": { "tags": [ "Subscriptions" ], "summary": "Cancel Pending Invitation", "description": "Cancels a pending User Invitation with the given Id for the given subscription.<br/><br/>[security] Required role action(s): SubscriptionCancelInvitation", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "invitationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionCancelInvitation" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/pending-invitations/{invitationId}/resend": { "post": { "tags": [ "Subscriptions" ], "summary": "Resend Pending User Invitation", "description": "Resends the User Invitation with the given Id.<br/><br/>[security] Required role action(s): SubscriptionResendInvitation", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "invitationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionResendInvitation" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/pending-invitations/check": { "post": { "tags": [ "Subscriptions" ], "summary": "Check Email Availability", "description": "Checks if the given email is already invited or joined to the given subscription. If that's the case, a 400 error response is thrown. When it has been already invited or it has already joined the subscription a 400 error is returned<br/><br/>[security] Required role action(s): SubscriptionCheckEmailForInvitation", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CheckEmailAvailabilityPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckEmailAvailabilityPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CheckEmailAvailabilityPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CheckEmailAvailabilityPayload" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionCheckEmailForInvitation" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/users/invite": { "put": { "tags": [ "Subscriptions" ], "summary": "Invite Users to Subscription", "description": "Creates and sends User Invitations to a subscription to all the given emails. Every UserInvitationPayload must have an available email and a valid roleId. To get all the available roles you can call the 'Get App Roles' endpoint.<br/><br/>[security] Required role action(s): SubscriptionInviteUsers", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SubscriptionUsersInvitationPayload" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionUsersInvitationPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriptionUsersInvitationPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubscriptionUsersInvitationPayload" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionInviteUsers" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/users/accept": { "put": { "tags": [ "Subscriptions" ], "summary": "Accept User Invitation", "description": "Accepts the User Invitation with the given key.", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/service-principal": { "get": { "tags": [ "Subscriptions" ], "summary": "Get Subscription Service Principal", "description": "Gets the subscription service principal.<br/><br/>[security] Required role action(s): SubscriptionGetServicePrincipal", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServicePrincipalDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionGetServicePrincipal" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/users/{userOrganizationId}/{userId}/enable": { "put": { "tags": [ "Subscriptions" ], "summary": "Enable User for Subscription", "description": "Enables a user in a Subscription.<br/><br/>[security] Required role action(s): SubscriptionEnableUser", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userOrganizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Role to be set to user once re-enabled", "content": { "application/json-patch+json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionEnableUser" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/users/{userOrganizationId}/{userId}/disable": { "put": { "tags": [ "Subscriptions" ], "summary": "Disable User for Subscription", "description": "Disables a user in a Subscription. The user won't be able to use the subscription at all while they're disabled.<br/><br/>[security] Required role action(s): SubscriptionDisableUser", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userOrganizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionDisableUser" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/users/{userOrganizationId}/{userId}/role": { "put": { "tags": [ "Subscriptions" ], "summary": "Set User Role", "description": "Changes the Role for a user in a Subscription.<br/><br/>[security] Required role action(s): SubscriptionSetUserRole", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userOrganizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionSetUserRole" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/users/{userOrganizationId}/{userId}/add": { "put": { "tags": [ "Subscriptions" ], "summary": "Add User to Subscription", "description": "Adds an user to a subscription with the viewer role (mainly used when directly accepting an user).<br/><br/>[security] Required role action(s): SubscriptionAddUser", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userOrganizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionUserDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionAddUser" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/users/{userOrganizationId}/{userId}": { "delete": { "tags": [ "Subscriptions" ], "summary": "Remove User from Subscription", "description": "Removes a user from a Subscription. To add the user again to the subscription, you'll have to send a new invitation by calling the 'Invite Users to Subscription' endpoint.<br/><br/>[security] Required role action(s): UsersRemoveFromSubscription", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userOrganizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "UsersRemoveFromSubscription" ] } ] } }, "/organizations/{organizationId}/available-subscriptions": { "get": { "tags": [ "Subscriptions" ], "summary": "Get available subscriptions to join.", "description": "Gets the list of subscriptions of the organization of the user that are available to be joined. Returns a simplified list of subscriptions.<br/><br/>[security] Required role action(s): SubscriptionGetAvailable", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfoDTO" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionGetAvailable" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionIdToGetAccess}/request-access": { "post": { "tags": [ "Subscriptions" ], "summary": "Request access to an existent subscription.", "description": "Generates a request to join the subscription by notifying all the administrators of the subscription. Subscription administrators may accept the request or not. An email will be sent back to the user who request access to the subscription in case of acceptance.<br/><br/>[security] Required role action(s): SubscriptionRequestAccess", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionIdToGetAccess", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionRequestAccess" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/access-request/{accessRequestId}/dismiss": { "put": { "tags": [ "Subscriptions" ], "summary": "Dismiss access request to an existent subscription.", "description": "An email will be sent back to the user who requested the access to the subscription notifying the dismiss with the custom message.<br/><br/>[security] Required role action(s): SubscriptionAccessRequestDismiss", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "accessRequestId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MailingInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MailingInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MailingInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MailingInfo" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionAccessRequestDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionAccessRequestDismiss" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/access-requests/{accessRequestId}/dismiss": { "put": { "tags": [ "Subscriptions" ], "summary": "Dismiss access request to an existent subscription.", "description": "An email will be sent back to the user who requested the access to the subscription notifying the dismiss with the custom message.<br/><br/>[security] Required role action(s): SubscriptionAccessRequestDismiss", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "accessRequestId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MailingInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MailingInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MailingInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MailingInfo" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionAccessRequestDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionAccessRequestDismiss" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/access-requests": { "get": { "tags": [ "Subscriptions" ], "summary": "Get all the access requests of a specific subscription.", "description": "These requests can only be made from users within the same organization.<br/><br/>[security] Required role action(s): SubscriptionGetAccessRequests", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAccessRequestDTO" } } } } }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionGetAccessRequests" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/access-requests/{accessRequestId}/accept": { "put": { "tags": [ "Subscriptions" ], "summary": "Accepts an access request for an existing subscription.", "description": "Accepts an access request for an existing subscription. These requests can only be made from users within the same organization.<br/><br/>[security] Required role action(s): SubscriptionAccessRequestAccept", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "accessRequestId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionAccessRequestAccept" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/access-requests/{accessRequestId}": { "put": { "tags": [ "Subscriptions" ], "summary": "Updates the role of an existing subscription access request.", "description": "Updates the role that the user will have if the subscription access request is accepted.<br/><br/>[security] Required role action(s): SubscriptionAccessRequestUpdateRole", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "accessRequestId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" }, "412": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "SubscriptionAccessRequestUpdateRole" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/free-trials": { "post": { "tags": [ "SubscriptionsFreeTrial" ], "summary": "Activate new free trial for given subscription", "description": "Activates new free trial for a given subscription as long as the subscription is eligible for a free trial.<br/><br/>[security] Required role action(s): SubscriptionFreeTrialActivate", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionFreeTrial" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionFreeTrialActivate" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/free-trials/reminder-subscribe": { "post": { "tags": [ "SubscriptionsFreeTrial" ], "summary": "Subscribe subscription to free trial reminders", "description": "Subscribes to receive free trial reminders about how much time is left until free trial period ends.<br/><br/>[security] Required role action(s): SubscriptionFreeTrialSubscribeReminder", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionDTO" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionFreeTrialSubscribeReminder" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/free-trials/reminder-unsubscribe": { "post": { "tags": [ "SubscriptionsFreeTrial" ], "summary": "Unsubscribe subscription from free trial reminders", "description": "Unsubscribes from receiving free trial reminders about how much time is left until free trial period ends.<br/><br/>[security] Required role action(s): SubscriptionFreeTrialUnsubscribeReminder", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionDTO" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionFreeTrialUnsubscribeReminder" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/usage/report": { "get": { "tags": [ "Usage" ], "summary": "Get subscription billing by period or date range", "description": "<br/><br/>[security] Required role action(s): SubscriptionBillingUsage", "parameters": [ { "name": "period", "in": "query", "description": "Only 0 (This month) and -1 (Last month) values supported", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "description": "ISO datetime of the beginning range", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "ISO datetime of the limit range", "schema": { "type": "string", "format": "date-time" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionBillingUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/usage/routes": { "get": { "tags": [ "Usage" ], "summary": "Get subscription billing by period or date range", "description": "<br/><br/>[security] Required role action(s): SubscriptionBillingUsage", "parameters": [ { "name": "period", "in": "query", "description": "Only 0 (This month) and -1 (Last month) values supported", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "description": "ISO datetime of the beginning range", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "ISO datetime of the limit range", "schema": { "type": "string", "format": "date-time" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionBillingUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/usage/csv/report": { "get": { "tags": [ "Usage" ], "summary": "Get subscription billing by period or date range in csv format", "description": "<br/><br/>[security] Required role action(s): SubscriptionBillingUsage", "parameters": [ { "name": "period", "in": "query", "description": "Only 0 (This month) and -1 (Last month) values supported", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "description": "ISO datetime of the beginning range", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "ISO datetime of the limit range", "schema": { "type": "string", "format": "date-time" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionBillingUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/usage/csv/routes": { "get": { "tags": [ "Usage" ], "summary": "Get subscription billing by period or date range in csv format", "description": "<br/><br/>[security] Required role action(s): SubscriptionBillingUsage", "parameters": [ { "name": "period", "in": "query", "description": "Only 0 (This month) and -1 (Last month) values supported", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "description": "ISO datetime of the beginning range", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "ISO datetime of the limit range", "schema": { "type": "string", "format": "date-time" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionBillingUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/usage/appliances": { "get": { "tags": [ "Usage" ], "summary": "Get appliances billing by subscription and date range", "description": "<br/><br/>[security] Required role action(s): SubscriptionBillingUsage", "parameters": [ { "name": "from", "in": "query", "description": "ISO datetime of the beginning range", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "ISO datetime of the limit range", "schema": { "type": "string", "format": "date-time" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionBillingUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/usage/csv/appliances": { "get": { "tags": [ "Usage" ], "summary": "Get appliances billing by subscription and date range in csv format", "description": "<br/><br/>[security] Required role action(s): SubscriptionBillingUsage", "parameters": [ { "name": "from", "in": "query", "description": "ISO datetime of the beginning range", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "ISO datetime of the limit range", "schema": { "type": "string", "format": "date-time" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionBillingUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/usage/cycles": { "get": { "tags": [ "Usage" ], "summary": "Get subscription's billing cycles", "description": "<br/><br/>[security] Required role action(s): SubscriptionBillingUsage", "parameters": [ { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "SubscriptionBillingUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/usage": { "get": { "tags": [ "Usage" ], "summary": "Get subscription's basic usage information", "description": "This endpoint will only return subscriptions in which the user has a role assigned with the SubscriptionsGet action.\r\nUsage data is available in organizations/{organizationId}/subscriptions/{subscriptionId}/usage<br/><br/>[security] Required role action(s): SubscriptionBillingUsage", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionUsageInformation" } } } } }, "security": [ { "oauth2": [ "SubscriptionBillingUsage" ] } ] } }, "/organizations/{organizationId}/subscriptions/{subscriptionId}/users": { "get": { "tags": [ "Users" ], "summary": "Get Subscription Users", "description": "Gets the list of users of a Subscription.<br/><br/>[security] Required role action(s): UsersGetUserSubscription", "parameters": [ { "name": "organizationId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "Example value: 596f5a7a-ee9c-4c41-a6d0-82e730410a2a", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionUserDTO" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } }, "security": [ { "oauth2": [ "UsersGetUserSubscription" ] } ] } } }, "components": { "schemas": { "AccessTokenPayload": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" } }, "additionalProperties": false }, "AccessTokenResponse": { "type": "object", "properties": { "accessToken": { "type": "string", "nullable": true }, "expiresInSeconds": { "type": "string", "nullable": true }, "expiresOnUtc": { "type": "string", "nullable": true }, "tokenType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Action": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90 ], "type": "integer", "format": "int32" }, "AddHubletRequestDTO": { "type": "object", "properties": { "inputs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "outputs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/HubletParameterRequestDTO" }, "nullable": true }, "definitionId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "alternateId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "probes": { "type": "array", "items": { "$ref": "#/components/schemas/HubletProbeDTO" }, "nullable": true } }, "additionalProperties": false }, "BuiltinRole": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/Action" }, "nullable": true }, "entityType": { "$ref": "#/components/schemas/EntityType" }, "_etag": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "updatedOn": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "_ts": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BulkHubletRequestDTO": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "outputs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/HubletParameterRequestDTO" }, "nullable": true }, "definitionId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "alternateId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "probes": { "type": "array", "items": { "$ref": "#/components/schemas/HubletProbeDTO" }, "nullable": true } }, "additionalProperties": false }, "BulkHubletRouteManagementInformation": { "type": "object", "properties": { "hubletRouteId": { "type": "string", "nullable": true }, "hubletRouteName": { "type": "string", "nullable": true }, "hubletRouteDescription": { "type": "string", "nullable": true }, "referralUrl": { "type": "string", "nullable": true }, "srtPassphrase": { "type": "string", "nullable": true }, "srtLatency": { "type": "string", "description": "It's the default latency set for containers. (Unit: Number)", "nullable": true }, "srtMode": { "type": "string", "description": "Possible values: Caller / Listener / Rendezvous", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "containerPort": { "type": "string", "nullable": true }, "containerUrl": { "type": "string", "nullable": true }, "rtmpEndpoint": { "type": "string", "nullable": true }, "secondaryRtmpEndpoint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkHubletRouteManagementInformationBulkOperationResult": { "type": "object", "properties": { "objectId": { "type": "string", "nullable": true }, "objectName": { "type": "string", "nullable": true }, "result": { "$ref": "#/components/schemas/BulkOperationResultItem" }, "errorMessage": { "type": "string", "nullable": true }, "additionalInformation": { "$ref": "#/components/schemas/BulkHubletRouteManagementInformation" } }, "additionalProperties": false }, "BulkOperationResultItem": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "ChangeLogEntry": { "required": [ "changes", "version" ], "type": "object", "properties": { "version": { "type": "string" }, "changes": { "type": "array", "items": { } } }, "additionalProperties": false }, "CheckEmailAvailabilityPayload": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } }, "additionalProperties": false }, "ClaimCodeActivationRequest": { "type": "object", "properties": { "subscriptionName": { "type": "string", "nullable": true }, "claimCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientCredentialsRequestPayload": { "required": [ "clientId", "roleId" ], "type": "object", "properties": { "clientId": { "type": "string" }, "roleId": { "type": "string" } }, "additionalProperties": false }, "ConfigListDTO": { "required": [ "changeLog", "description", "name", "version" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { }, "version": { "$ref": "#/components/schemas/VersionInfo" }, "changeLog": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeLogEntry" } } }, "additionalProperties": false }, "CreateOrganizationPayload": { "type": "object", "properties": { "organizationId": { "type": "string", "nullable": true }, "orgAdminUserId": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean", "description": "Represents if the document is enabled to opperate." }, "organizationName": { "type": "string", "nullable": true }, "organizationDomain": { "type": "string", "nullable": true }, "roleAssignments": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CreateUpdateHubletRouteRequestDTO": { "required": [ "hublets" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "hublets": { "type": "array", "items": { "$ref": "#/components/schemas/BulkHubletRequestDTO" } }, "name": { "type": "string", "nullable": true }, "eTag": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "customRttMultiplier": { "type": "number", "format": "double" }, "routeStatus": { "type": "string", "nullable": true }, "jsonData": { "type": "string", "nullable": true }, "autoStartRoute": { "type": "boolean", "description": "If AutoStartRoute is set as true, the Hublet Route's start process will be triggered after being created. This parameter won't have effect when executing the 'Update Hublet Route' endpoint." }, "routeDurationLimit": { "type": "number", "format": "double", "nullable": true }, "alternateId": { "type": "string", "nullable": true }, "referralUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DependencyType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "DisplayDataParameter": { "required": [ "description", "key", "type" ], "type": "object", "properties": { "key": { "type": "string" }, "type": { "$ref": "#/components/schemas/HubletDefinitionParameterType" }, "description": { "type": "string" }, "format": { "nullable": true } }, "additionalProperties": false }, "EntityType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "type": "integer", "format": "int32" }, "ErrorResult": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "error": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "identifier": { "type": "string", "nullable": true }, "innerException": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "additionalInformation": { "nullable": true }, "innerExceptions": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResult" }, "nullable": true } }, "additionalProperties": false }, "ExternalHubletDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean", "description": "Represents if the document is enabled to opperate." }, "hubletName": { "type": "string", "nullable": true }, "hubletType": { "$ref": "#/components/schemas/HubletType" }, "bandwidthUsage": { "type": "string", "nullable": true }, "timeUsage": { "type": "string", "description": "Represents the time usage in seconds", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "hubletDefinition": { "$ref": "#/components/schemas/HubletDefinitionDTO" } }, "additionalProperties": false }, "ExternalHubletData": { "type": "object", "properties": { "sharedKeyvaultEndpoint": { "type": "string", "nullable": true }, "hubletServiceApiEndpoint": { "type": "string", "nullable": true }, "factoryId": { "type": "string", "nullable": true }, "configName": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ExternalHubletRegistrationRequestDTO": { "required": [ "configName", "credentials", "factoryId", "hubletDefinition" ], "type": "object", "properties": { "hubletDefinition": { "$ref": "#/components/schemas/HubletDefinition" }, "configName": { "type": "string" }, "factoryId": { "type": "string" }, "credentials": { "$ref": "#/components/schemas/ServicePrincipalVault" } }, "additionalProperties": false }, "ExternalHubletServiceRequestDTO": { "required": [ "payload", "url" ], "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/ServicePrincipalVault" }, "url": { "type": "string" } }, "additionalProperties": false }, "FactoryListDTO": { "required": [ "description", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { } }, "additionalProperties": false }, "FreeTrialPeriod": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "activatedBy": { "$ref": "#/components/schemas/FreeTrialPeriodActivator" }, "featuresEnabled": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "FreeTrialPeriodActivator": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FreeTrialPeriodDTO": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "activatedBy": { "$ref": "#/components/schemas/FreeTrialPeriodActivator" } }, "additionalProperties": false }, "HealthStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "HistoryByBandwidthDTO": { "type": "object", "properties": { "totalBandwidthInput": { "type": "number", "description": "Represents the total bandwidth usage in MB/s", "format": "double" }, "totalBandwidthOutput": { "type": "number", "description": "Represents the total bandwidth usage in MB/s", "format": "double" }, "timestamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "HttpContent": { "type": "object", "properties": { "headers": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringIEnumerableKeyValuePair" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "HttpMethod": { "type": "object", "properties": { "method": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HttpRequestMessage": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "content": { "$ref": "#/components/schemas/HttpContent" }, "method": { "$ref": "#/components/schemas/HttpMethod" }, "requestUri": { "type": "string", "format": "uri", "nullable": true }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringIEnumerableKeyValuePair" }, "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "HttpResponseMessage": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "content": { "$ref": "#/components/schemas/HttpContent" }, "statusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "reasonPhrase": { "type": "string", "nullable": true }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringIEnumerableKeyValuePair" }, "nullable": true, "readOnly": true }, "trailingHeaders": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringIEnumerableKeyValuePair" }, "nullable": true, "readOnly": true }, "requestMessage": { "$ref": "#/components/schemas/HttpRequestMessage" }, "isSuccessStatusCode": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "HttpStatusCode": { "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511 ], "type": "integer", "format": "int32" }, "HubletBranding": { "required": [ "background", "logos" ], "type": "object", "properties": { "background": { "type": "string" }, "logos": { "$ref": "#/components/schemas/HubletLogos" } }, "additionalProperties": false }, "HubletDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "outputs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/Parameter" }, "nullable": true }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/HubletResource" }, "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/HubletStatus" }, "displayData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "states": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "referalURL": { "type": "string", "nullable": true }, "alternateId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "definitionId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "probes": { "type": "array", "items": { "$ref": "#/components/schemas/HubletProbeDTO" }, "nullable": true }, "isDynamic": { "type": "boolean" }, "hasProbes": { "type": "boolean", "readOnly": true }, "telemetryRelevantConnections": { "type": "array", "items": { "$ref": "#/components/schemas/TelemetryRelevantConnectionDTO" }, "nullable": true } }, "additionalProperties": false }, "HubletDefinition": { "required": [ "branding", "hubletData", "hubletServiceApiEndpoint", "metadata", "sharedKeyvaultEndpoint", "statusUpdateThresholdsInSeconds", "supportedRegions", "telemetryProperties" ], "type": "object", "properties": { "sharedKeyvaultEndpoint": { "type": "string", "format": "uri" }, "hubletServiceApiEndpoint": { "type": "string", "format": "uri" }, "statusUpdateThresholdsInSeconds": { "type": "object", "properties": { "CommandInProgress": { "type": "integer", "format": "int32" }, "NetworkAvailable": { "type": "integer", "format": "int32" }, "HubletStarted": { "type": "integer", "format": "int32" }, "HubletConfigured": { "type": "integer", "format": "int32" }, "HubletAvailable": { "type": "integer", "format": "int32" }, "CommandComplete": { "type": "integer", "format": "int32" }, "InternalFailure": { "type": "integer", "format": "int32" }, "Rejected": { "type": "integer", "format": "int32" }, "CreationFailed": { "type": "integer", "format": "int32" }, "RuntimeConfigurationFailed": { "type": "integer", "format": "int32" }, "HubletUnknown": { "type": "integer", "format": "int32" }, "HubletStopped": { "type": "integer", "format": "int32" }, "HubletTerminated": { "type": "integer", "format": "int32" }, "HubletError": { "type": "integer", "format": "int32" }, "ProvisioningError": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "supportedRegions": { "type": "array", "items": { "type": "string" } }, "metadata": { "$ref": "#/components/schemas/HubletDefinitionMetadata" }, "branding": { "$ref": "#/components/schemas/HubletBranding" }, "hubletData": { "$ref": "#/components/schemas/HubletDefinitionData" }, "telemetryProperties": { "$ref": "#/components/schemas/TelemetryProperties" }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HubletDefinitionCommand": { "required": [ "commandHandler", "commandName", "disabledStates", "stateChange" ], "type": "object", "properties": { "commandName": { "type": "string" }, "commandDescription": { "type": "string", "nullable": true }, "commandHandler": { "type": "string" }, "stateChange": { "type": "array", "items": { "$ref": "#/components/schemas/HubletDefinitionCommandStateChange" }, "nullable": true }, "disabledStates": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "HubletDefinitionCommandStateChange": { "required": [ "hubletStateKey" ], "type": "object", "properties": { "hubletStateKey": { "type": "string" }, "hubletStateNewValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HubletDefinitionContainerSpec": { "type": "object", "properties": { "image": { "type": "string", "nullable": true, "deprecated": true }, "imageName": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true, "readOnly": true }, "cpuCoreCount": { "type": "integer", "format": "int32" }, "toleration": { "$ref": "#/components/schemas/Toleration" }, "memorySizeInGb": { "type": "string", "nullable": true }, "externalUdpPorts": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "externalTcpPorts": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "defaultOutputProtocol": { "type": "string", "nullable": true }, "os": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HubletDefinitionDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "metadata": { "$ref": "#/components/schemas/InternalHubletDefinitionMetadata" }, "branding": { "$ref": "#/components/schemas/HubletBranding" }, "hubletData": { "$ref": "#/components/schemas/HubletDefinitionData" }, "hubletGroup": { "$ref": "#/components/schemas/HubletGroup" }, "statusUpdateThresholdsInSeconds": { "type": "object", "properties": { "CommandInProgress": { "type": "integer", "format": "int32" }, "NetworkAvailable": { "type": "integer", "format": "int32" }, "HubletStarted": { "type": "integer", "format": "int32" }, "HubletConfigured": { "type": "integer", "format": "int32" }, "HubletAvailable": { "type": "integer", "format": "int32" }, "CommandComplete": { "type": "integer", "format": "int32" }, "InternalFailure": { "type": "integer", "format": "int32" }, "Rejected": { "type": "integer", "format": "int32" }, "CreationFailed": { "type": "integer", "format": "int32" }, "RuntimeConfigurationFailed": { "type": "integer", "format": "int32" }, "HubletUnknown": { "type": "integer", "format": "int32" }, "HubletStopped": { "type": "integer", "format": "int32" }, "HubletTerminated": { "type": "integer", "format": "int32" }, "HubletError": { "type": "integer", "format": "int32" }, "ProvisioningError": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Status details:\r\ncommandInProgress: This status represents that the hubletService is working on the request.\r\nNetworkAvailable: This status represents that the external resource is available in the network (ready to use).\r\nHubletStarted: This status represents that the external hublet started successfully.", "nullable": true }, "supportedRegions": { "type": "array", "items": { "$ref": "#/components/schemas/HubletRegion" }, "nullable": true }, "provisionResources": { "$ref": "#/components/schemas/HubletProvisionResourcesDTO" }, "version": { "type": "string", "nullable": true }, "routingType": { "$ref": "#/components/schemas/RoutingType" } }, "additionalProperties": false }, "HubletDefinitionData": { "required": [ "displayData", "localization", "parameters" ], "type": "object", "properties": { "displayData": { "$ref": "#/components/schemas/HubletDefinitionDisplayData" }, "localization": { }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/HubletDefinitionParameter" } }, "systemParameters": { "type": "array", "items": { "$ref": "#/components/schemas/HubletDefinitionSystemParameter" }, "nullable": true }, "commands": { "type": "array", "items": { "$ref": "#/components/schemas/HubletDefinitionCommand" }, "nullable": true }, "hubletStates": { "type": "array", "items": { "$ref": "#/components/schemas/HubletDefinitionState" }, "nullable": true } }, "additionalProperties": false }, "HubletDefinitionDisplayData": { "required": [ "hublet", "system", "user" ], "type": "object", "properties": { "system": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayDataParameter" } }, "hublet": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayDataParameter" } }, "user": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayDataParameter" } } }, "additionalProperties": false }, "HubletDefinitionMetadata": { "required": [ "description", "hubletName", "hubletSDKVersion", "hubletType" ], "type": "object", "properties": { "hubletName": { "type": "string" }, "hubletType": { "type": "string" }, "hubletSDKVersion": { "$ref": "#/components/schemas/Version" }, "description": { "type": "string" }, "vendor": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "labels": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "isOlympiaPod": { "type": "boolean" } }, "additionalProperties": false }, "HubletDefinitionParameter": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/HubletDefinitionParameterType" }, "appConfigurationField": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "tooltip": { "type": "string", "nullable": true }, "placeHolder": { "type": "string", "nullable": true }, "defaultValue": { "nullable": true }, "min": { "type": "integer", "format": "int32" }, "max": { "type": "integer", "format": "int32" }, "scale": { "type": "integer", "format": "int32" }, "pattern": { "type": "string", "nullable": true }, "multiLine": { "type": "boolean" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringKeyValuePair" }, "nullable": true } }, "additionalProperties": false }, "HubletDefinitionParameterType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "HubletDefinitionProvision": { "type": "object", "properties": { "processor": { "type": "string", "nullable": true }, "isProvisionSynchronous": { "type": "boolean" }, "containerSpec": { "$ref": "#/components/schemas/HubletDefinitionContainerSpec" }, "telemetryProperties": { "$ref": "#/components/schemas/TelemetryProperties" }, "connectionSideWithMainResource": { "$ref": "#/components/schemas/DependencyType" } }, "additionalProperties": false }, "HubletDefinitionProvisionDTO": { "type": "object", "properties": { "telemetryProperties": { "$ref": "#/components/schemas/HubletTelemetryPropertiesConfigDTO" } }, "additionalProperties": false }, "HubletDefinitionState": { "required": [ "stateName" ], "type": "object", "properties": { "stateName": { "type": "string" }, "stateDescription": { "type": "string", "nullable": true }, "initialValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HubletDefinitionSystemParameter": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/HubletDefinitionParameterType" }, "description": { "type": "string", "nullable": true }, "placeHolder": { "type": "string", "nullable": true }, "value": { "nullable": true }, "pattern": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HubletGroup": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "HubletLogos": { "required": [ "hubletCreationLogo", "hubletDetailsLogo", "hubletPillLogo" ], "type": "object", "properties": { "hubletCreationLogo": { "type": "string" }, "hubletDetailsLogo": { "type": "string" }, "hubletPillLogo": { "type": "string" } }, "additionalProperties": false }, "HubletParameterRequestDTO": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HubletProbeDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "probeDefinitionId": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "HubletProvisionResources": { "type": "object", "properties": { "preProvision": { "$ref": "#/components/schemas/HubletDefinitionProvision" }, "mainProvision": { "$ref": "#/components/schemas/HubletDefinitionProvision" }, "postProvision": { "$ref": "#/components/schemas/HubletDefinitionProvision" } }, "additionalProperties": false }, "HubletProvisionResourcesDTO": { "type": "object", "properties": { "preProvision": { "$ref": "#/components/schemas/HubletDefinitionProvisionDTO" }, "mainProvision": { "$ref": "#/components/schemas/HubletDefinitionProvisionDTO" }, "postProvision": { "$ref": "#/components/schemas/HubletDefinitionProvisionDTO" } }, "additionalProperties": false }, "HubletRegion": { "required": [ "description", "index", "regionId", "zone" ], "type": "object", "properties": { "regionId": { "type": "string" }, "description": { "type": "string" }, "zone": { "type": "string" }, "index": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HubletResource": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ProvisionError" }, "nullable": true }, "topologyId": { "type": "string", "nullable": true }, "routeId": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "provisionStartTime": { "type": "string", "format": "date-time", "nullable": true }, "provisionEndTime": { "type": "string", "format": "date-time", "nullable": true }, "data": { "$ref": "#/components/schemas/HubletResourceData" }, "status": { "$ref": "#/components/schemas/HubletResourceStatus" }, "externalStatus": { "$ref": "#/components/schemas/HubletStatusType" }, "hubletId": { "type": "string", "nullable": true }, "hubletDefinitionId": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "provisionContract": { "$ref": "#/components/schemas/ProvisionContract" }, "generatesTelemetry": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isInfrastructureResource": { "type": "boolean" }, "inputInternalContainerLatency": { "type": "integer", "format": "int32" }, "outputInternalContainerLatency": { "type": "integer", "format": "int32" }, "provisionHandlerType": { "$ref": "#/components/schemas/ProvisionHandlerType" }, "dependencies": { "type": "array", "items": { "type": "string" }, "nullable": true, "deprecated": true }, "orchestratingDependencies": { "type": "array", "items": { "$ref": "#/components/schemas/HubletResourceDependency" }, "nullable": true, "readOnly": true }, "typedDependencies": { "type": "array", "items": { "$ref": "#/components/schemas/HubletResourceDependency" }, "nullable": true }, "userId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "states": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/Parameter" }, "nullable": true }, "version": { "type": "string", "nullable": true }, "internalId": { "type": "string", "nullable": true, "readOnly": true }, "deprovisionEndTime": { "type": "string", "format": "date-time", "nullable": true }, "deprovisionStartTime": { "type": "string", "format": "date-time", "nullable": true }, "addedBy": { "type": "string", "nullable": true }, "addedOn": { "type": "string", "format": "date-time" }, "deletedBy": { "type": "string", "nullable": true }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "entityType": { "$ref": "#/components/schemas/EntityType" }, "_etag": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "updatedOn": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "_ts": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "HubletResourceConnectivityData": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "protocol": { "$ref": "#/components/schemas/HubletResourceProtocol" }, "srtConfig": { "$ref": "#/components/schemas/SrtConfiguration" }, "ipAddress": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" }, "fqdn": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HubletResourceDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "topologyId": { "type": "string", "nullable": true }, "routeId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/HubletResourceData" }, "externalStatus": { "$ref": "#/components/schemas/HubletStatusType" }, "status": { "$ref": "#/components/schemas/HubletResourceStatus" }, "hubletId": { "type": "string", "nullable": true }, "hubletDefinitionId": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "isInfrastructureResource": { "type": "boolean" }, "provisionStartTime": { "type": "string", "format": "date-time", "nullable": true }, "provisionEndTime": { "type": "string", "format": "date-time", "nullable": true }, "provisionContract": { "$ref": "#/components/schemas/ProvisionContract" }, "provisionHandlerType": { "$ref": "#/components/schemas/ProvisionHandlerType" }, "dependencies": { "type": "array", "items": { "type": "string" }, "nullable": true, "deprecated": true }, "orchestratingDependencies": { "type": "array", "items": { "$ref": "#/components/schemas/HubletResourceDependency" }, "nullable": true }, "typedDependencies": { "type": "array", "items": { "$ref": "#/components/schemas/HubletResourceDependency" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ProvisionErrorDTO" }, "nullable": true }, "states": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HubletResourceData": { "type": "object", "properties": { "inputConnectivityData": { "type": "array", "items": { "$ref": "#/components/schemas/HubletResourceConnectivityData" }, "nullable": true }, "outputConnectivityData": { "type": "array", "items": { "$ref": "#/components/schemas/HubletResourceConnectivityData" }, "nullable": true }, "connectivityData": { "$ref": "#/components/schemas/HubletResourceConnectivityData" }, "hubletParameters": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "commandId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "HubletResourceDependency": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/DependencyType" } }, "additionalProperties": false }, "HubletResourceDetailErrorDTO": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "hubletName": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ProvisionErrorDTO" }, "nullable": true } }, "additionalProperties": false }, "HubletResourceProtocol": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "HubletResourceStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "HubletRouteDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "hublets": { "type": "array", "items": { "$ref": "#/components/schemas/HubletDTO" }, "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "createdFrom": { "type": "string", "nullable": true }, "jsonData": { "type": "string", "nullable": true }, "topologyId": { "type": "string", "nullable": true }, "eTag": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/HubletRouteStatus" }, "errors": { "type": "array", "items": { }, "nullable": true }, "interContainerLatency": { "type": "integer", "format": "int32", "nullable": true }, "customRttMultiplier": { "type": "number", "format": "double" }, "streamingRunningTime": { "type": "number", "format": "double", "nullable": true }, "telemetryStatus": { "$ref": "#/components/schemas/RouteTelemetryStatusDTO" }, "routeDurationLimit": { "type": "number", "format": "double", "nullable": true }, "roleAssignments": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "isProvisionFailed": { "type": "boolean" }, "alternateId": { "type": "string", "nullable": true }, "referralUrl": { "type": "string", "nullable": true }, "hubletResources": { "type": "array", "items": { "$ref": "#/components/schemas/HubletResourceDTO" }, "nullable": true }, "hasInvalidStructure": { "type": "boolean" }, "updatedOn": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "HubletRouteDTOPagedResult": { "type": "object", "properties": { "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "nextPageToken": { "type": "string", "nullable": true }, "hasNextPage": { "type": "boolean", "readOnly": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HubletRouteDTO" }, "nullable": true } }, "additionalProperties": false }, "HubletRouteInstanceStartTimeDTO": { "type": "object", "properties": { "startTimeInSecs": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "routeInstanceId": { "type": "string", "description": "Represents the id of the document with the route execution detail", "nullable": true } }, "additionalProperties": false }, "HubletRouteStartTimeDTO": { "type": "object", "properties": { "routeId": { "type": "string", "nullable": true }, "routeInstances": { "type": "array", "items": { "$ref": "#/components/schemas/HubletRouteInstanceStartTimeDTO" }, "nullable": true } }, "additionalProperties": false }, "HubletRouteStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "HubletStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "HubletStatusType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 ], "type": "integer", "format": "int32" }, "HubletStreamingStatusDTO": { "type": "object", "properties": { "activeTime": { "type": "number", "format": "double" }, "streamingTime": { "type": "number", "format": "double" }, "conflictedTime": { "type": "number", "format": "double" }, "timestamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "HubletTelemetryDTO": { "type": "object", "properties": { "resourceId": { "type": "string", "nullable": true }, "cpuUsage": { "type": "array", "items": { "$ref": "#/components/schemas/MetricValueDTO" }, "nullable": true }, "memoryUsage": { "type": "array", "items": { "$ref": "#/components/schemas/MetricValueDTO" }, "nullable": true }, "networkBytesReceivedPerSecond": { "type": "array", "items": { "$ref": "#/components/schemas/MetricValueDTO" }, "nullable": true }, "networkBytesTransmittedPerSecond": { "type": "array", "items": { "$ref": "#/components/schemas/MetricValueDTO" }, "nullable": true } }, "additionalProperties": false }, "HubletTelemetryPropertiesConfigDTO": { "type": "object", "properties": { "relevantConnection": { "$ref": "#/components/schemas/TelemetryRelevantConnection" }, "configuration": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/HubletTelemetryPropertyDTO" }, "nullable": true } }, "additionalProperties": false }, "HubletTelemetryPropertyDTO": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TelemetryDataType" }, "description": { "type": "string", "nullable": true }, "format": { "nullable": true }, "section": { "type": "string", "nullable": true }, "views": { "type": "array", "items": { "type": "string" }, "nullable": true }, "inputOutputDisplay": { "$ref": "#/components/schemas/TelemetryInputOutputDisplaySettings" } }, "additionalProperties": false }, "HubletType": { "enum": [ "input", "output", "processing", "infrastructure", "probe" ], "type": "string" }, "IdentityUserFlow": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "InternalHubletDefinition": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/InternalHubletDefinitionMetadata" }, "branding": { "$ref": "#/components/schemas/HubletBranding" }, "externalHubletData": { "$ref": "#/components/schemas/ExternalHubletData" }, "hubletData": { "$ref": "#/components/schemas/HubletDefinitionData" }, "provisionResources": { "$ref": "#/components/schemas/HubletProvisionResources" }, "featureFlag": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "servicePrincipalSecretId": { "type": "string", "nullable": true }, "supportedRegions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "statusUpdateThresholdsInSeconds": { "type": "object", "properties": { "CommandInProgress": { "type": "integer", "format": "int32" }, "NetworkAvailable": { "type": "integer", "format": "int32" }, "HubletStarted": { "type": "integer", "format": "int32" }, "HubletConfigured": { "type": "integer", "format": "int32" }, "HubletAvailable": { "type": "integer", "format": "int32" }, "CommandComplete": { "type": "integer", "format": "int32" }, "InternalFailure": { "type": "integer", "format": "int32" }, "Rejected": { "type": "integer", "format": "int32" }, "CreationFailed": { "type": "integer", "format": "int32" }, "RuntimeConfigurationFailed": { "type": "integer", "format": "int32" }, "HubletUnknown": { "type": "integer", "format": "int32" }, "HubletStopped": { "type": "integer", "format": "int32" }, "HubletTerminated": { "type": "integer", "format": "int32" }, "HubletError": { "type": "integer", "format": "int32" }, "ProvisioningError": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "nullable": true }, "hubletGroup": { "$ref": "#/components/schemas/HubletGroup" }, "routingType": { "$ref": "#/components/schemas/RoutingType" }, "entityType": { "$ref": "#/components/schemas/EntityType" }, "_etag": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "updatedOn": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "_ts": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "InternalHubletDefinitionMetadata": { "type": "object", "properties": { "hubletName": { "type": "string", "nullable": true }, "hubletType": { "$ref": "#/components/schemas/HubletType" }, "description": { "type": "string", "nullable": true }, "hubletComponent": { "type": "string", "nullable": true }, "vendor": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "labels": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "isOlympiaPod": { "type": "boolean" }, "nullableRegion": { "type": "boolean" }, "hubletValidator": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MailingInfo": { "type": "object", "properties": { "userEmail": { "type": "string", "nullable": true }, "customNotificationMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MetricValueDTO": { "type": "object", "properties": { "timeStamp": { "type": "string", "format": "date-time" }, "average": { "type": "number", "format": "double" } }, "additionalProperties": false }, "NodeTelemetryStatus": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "OlympiaHubletDefinition": { "type": "object", "properties": { "branding": { "$ref": "#/components/schemas/HubletBranding" }, "containerSpec": { "$ref": "#/components/schemas/HubletDefinitionContainerSpec" }, "hubletData": { "$ref": "#/components/schemas/HubletDefinitionData" }, "metadata": { "$ref": "#/components/schemas/HubletDefinitionMetadata" }, "telemetryProperties": { "$ref": "#/components/schemas/TelemetryProperties" }, "version": { "$ref": "#/components/schemas/Version" } }, "additionalProperties": false }, "OlympiaHubletRegistrationRequestDTO": { "required": [ "olympiaHubletDefinition" ], "type": "object", "properties": { "olympiaHubletDefinition": { "$ref": "#/components/schemas/OlympiaHubletDefinition" } }, "additionalProperties": false }, "OrganizationAuthorizationDTO": { "type": "object", "properties": { "organizationId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "domain": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganizationDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean", "description": "Represents if the document is enabled to opperate." }, "role": { "$ref": "#/components/schemas/RoleDTO" }, "domain": { "type": "string", "nullable": true }, "organizationStatus": { "$ref": "#/components/schemas/OrganizationStatus" } }, "additionalProperties": false }, "OrganizationStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Parameter": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PersistedNotificationDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "notificationType": { "$ref": "#/components/schemas/PersistedNotificationType" }, "message": { "type": "string", "nullable": true }, "redirectUri": { "type": "string", "nullable": true }, "datetime": { "type": "string", "format": "date-time" }, "wasRead": { "type": "boolean" }, "userId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PersistedNotificationDTOPagedResult": { "type": "object", "properties": { "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "nextPageToken": { "type": "string", "nullable": true }, "hasNextPage": { "type": "boolean", "readOnly": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PersistedNotificationDTO" }, "nullable": true } }, "additionalProperties": false }, "PersistedNotificationType": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "PreferredTheme": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProvisionContract": { "type": "object", "properties": { "isProvision": { "type": "boolean", "readOnly": true }, "isProvisionSynchronous": { "type": "boolean" } }, "additionalProperties": false }, "ProvisionError": { "type": "object", "properties": { "timeStamp": { "type": "string", "format": "date-time" }, "code": { "type": "string", "nullable": true }, "provisionState": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "isUnrecoverable": { "type": "boolean" } }, "additionalProperties": false }, "ProvisionErrorDTO": { "type": "object", "properties": { "timeStamp": { "type": "string", "format": "date-time" }, "provisionState": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "isUnrecoverable": { "type": "boolean", "description": "When this property is TRUE, the provision or deprovision is stopped and the route is marked as incompleted.\r\nWhen this property is FALSE, that indicates a transient error and does not affect the provisioning state." } }, "additionalProperties": false }, "ProvisionHandlerType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "RTTMultiplierDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "RegionCoordinates": { "type": "object", "properties": { "latitude": { "type": "number", "format": "float" }, "longitude": { "type": "number", "format": "float" } }, "additionalProperties": false }, "RegionItem": { "type": "object", "properties": { "regionId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "zone": { "type": "string", "nullable": true }, "billingZone": { "type": "string", "nullable": true }, "geographicSubRegion": { "type": "string", "nullable": true }, "coordinates": { "$ref": "#/components/schemas/RegionCoordinates" }, "index": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/RegionStatus" } }, "additionalProperties": false }, "RegionStatus": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "ResourceGroup": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RoleDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/Action" }, "nullable": true } }, "additionalProperties": false }, "RouteErrorDTO": { "type": "object", "properties": { "topologyErrors": { "type": "array", "items": { "$ref": "#/components/schemas/TopologyDetailErrorDTO" }, "nullable": true }, "hubletResourceErrors": { "type": "array", "items": { "$ref": "#/components/schemas/HubletResourceDetailErrorDTO" }, "nullable": true } }, "additionalProperties": false }, "RouteTelemetryDTO": { "type": "object", "properties": { "routeId": { "type": "string", "nullable": true }, "telemetries": { "type": "array", "items": { "$ref": "#/components/schemas/HubletTelemetryDTO" }, "nullable": true } }, "additionalProperties": false }, "RouteTelemetryHublet": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/HealthStatus" }, "isStreaming": { "type": "boolean" } }, "additionalProperties": false }, "RouteTelemetryHubletResource": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "hubletId": { "type": "string", "nullable": true }, "telemetryStatus": { "$ref": "#/components/schemas/NodeTelemetryStatus" }, "node": { "$ref": "#/components/schemas/RouteTelemetryNode" }, "route": { "$ref": "#/components/schemas/RouteTelemetryNode" }, "input": { "type": "array", "items": { "$ref": "#/components/schemas/RouteTelemetryNode" }, "nullable": true }, "output": { "type": "array", "items": { "$ref": "#/components/schemas/RouteTelemetryNode" }, "nullable": true }, "status": { "$ref": "#/components/schemas/HealthStatus" }, "isStreaming": { "type": "boolean" }, "hubletResourceType": { "$ref": "#/components/schemas/HubletType" }, "hubletResourceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RouteTelemetryNode": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isStreaming": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/HealthStatus" } }, "additionalProperties": false }, "RouteTelemetryStatusDTO": { "type": "object", "properties": { "routeId": { "type": "string", "nullable": true }, "hubletResources": { "type": "array", "items": { "$ref": "#/components/schemas/RouteTelemetryHubletResource" }, "nullable": true }, "hublets": { "type": "array", "items": { "$ref": "#/components/schemas/RouteTelemetryHublet" }, "nullable": true }, "routeStatus": { "$ref": "#/components/schemas/HealthStatus" }, "isStreaming": { "type": "boolean" } }, "additionalProperties": false }, "RoutingType": { "enum": [ "Direct", "Cloud" ], "type": "string" }, "ServicePrincipalDTO": { "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "tenantId": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServicePrincipalVault": { "type": "object", "properties": { "applicationClientId": { "type": "string", "nullable": true }, "applicationClientSecret": { "type": "string", "nullable": true }, "tenantId": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "applicationScopeUri": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SrtConfiguration": { "type": "object", "properties": { "srtMode": { "$ref": "#/components/schemas/SrtMode" }, "srtLatency": { "type": "integer", "format": "int32" }, "srtPassphrase": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SrtMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "StringStringIEnumerableKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StringStringKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubscriptionAccessRequestDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "roleId": { "type": "string", "nullable": true }, "accepted": { "type": "boolean" }, "rejected": { "type": "boolean" }, "deleted": { "type": "boolean" }, "pending": { "type": "boolean" } }, "additionalProperties": false }, "SubscriptionDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "organizationDomain": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/RoleDTO" }, "memberCount": { "type": "integer", "format": "int32" }, "activeRouteCount": { "type": "integer", "format": "int32", "deprecated": true }, "timeUsage": { "type": "integer", "description": "Represents the time usage in seconds", "format": "int32", "deprecated": true }, "azurePlanId": { "type": "string", "nullable": true }, "azureSubscriptionId": { "type": "string", "format": "uuid" }, "resourceGroup": { "$ref": "#/components/schemas/ResourceGroup" }, "defaultRttMultiplier": { "type": "number", "description": "The default multiplier for the calculated latency between containers. (default value: 4)", "format": "double", "nullable": true }, "rttMultipliers": { "type": "array", "items": { "$ref": "#/components/schemas/RTTMultiplierDTO" }, "nullable": true }, "isDisabled": { "type": "boolean" }, "freeTrial": { "$ref": "#/components/schemas/SubscriptionFreeTrialDTO" } }, "additionalProperties": false }, "SubscriptionFreeTrial": { "type": "object", "properties": { "periods": { "type": "array", "items": { "$ref": "#/components/schemas/FreeTrialPeriod" }, "nullable": true }, "isReminderEnabled": { "type": "boolean", "nullable": true }, "lengthInDays": { "type": "integer", "format": "int32", "nullable": true }, "features": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SubscriptionFreeTrialDTO": { "type": "object", "properties": { "periods": { "type": "array", "items": { "$ref": "#/components/schemas/FreeTrialPeriodDTO" }, "nullable": true }, "isReminderEnabled": { "type": "boolean", "nullable": true }, "lengthInDays": { "type": "integer", "format": "int32", "nullable": true }, "isEligible": { "type": "boolean", "nullable": true }, "isActive": { "type": "boolean" }, "currentStartDate": { "type": "string", "format": "date-time", "nullable": true }, "currentEndDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SubscriptionHubletRouteStartTimes": { "type": "object", "properties": { "subscriptionId": { "type": "string", "nullable": true }, "routes": { "type": "array", "items": { "$ref": "#/components/schemas/HubletRouteStartTimeDTO" }, "nullable": true } }, "additionalProperties": false }, "SubscriptionInfoDTO": { "type": "object", "properties": { "organizationId": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "subscriptionName": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "administratorName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubscriptionKey": { "type": "object", "properties": { "subscriptionId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubscriptionUsageInformation": { "type": "object", "properties": { "subscriptionId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "activeRouteCount": { "type": "integer", "format": "int32" }, "timeUsage": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SubscriptionUserDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/BuiltinRole" }, "routesCreated": { "type": "integer", "format": "int32" }, "timeUsage": { "type": "integer", "description": "Represents the time usage in seconds", "format": "int64" }, "isApplication": { "type": "boolean" } }, "additionalProperties": false }, "SubscriptionUsersInvitationPayload": { "required": [ "invitations" ], "type": "object", "properties": { "invitations": { "type": "array", "items": { "$ref": "#/components/schemas/UserInvitationPayload" } }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TelemetryDataType": { "enum": [ "string", "number", "url", "password", "percentage" ], "type": "string" }, "TelemetryInputOutputDisplaySettings": { "enum": [ "Both", "Input", "Output" ], "type": "string" }, "TelemetryMessageSection": { "enum": [ "Generic", "Container", "InputOutput", "InputOutputSession", "Channel" ], "type": "string" }, "TelemetryProperties": { "required": [ "configuration" ], "type": "object", "properties": { "configuration": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TelemetryProperty" } }, "relevantConnection": { "$ref": "#/components/schemas/TelemetryRelevantConnection" } }, "additionalProperties": false }, "TelemetryProperty": { "required": [ "description", "location", "messageSection", "section", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TelemetryDataType" }, "location": { "type": "string" }, "description": { "type": "string" }, "format": { "nullable": true }, "section": { "type": "string" }, "messageSection": { "$ref": "#/components/schemas/TelemetryMessageSection" }, "views": { "type": "array", "items": { "type": "string" }, "nullable": true }, "inputOutputDisplay": { "$ref": "#/components/schemas/TelemetryInputOutputDisplaySettings" } }, "additionalProperties": false }, "TelemetryRelevantConnection": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "TelemetryRelevantConnectionDTO": { "type": "object", "properties": { "resourceId": { "type": "string", "nullable": true }, "relevantConnection": { "$ref": "#/components/schemas/TelemetryRelevantConnection" } }, "additionalProperties": false }, "Toleration": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "operator": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "effect": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TopologyDetailErrorDTO": { "type": "object", "properties": { "topologyId": { "type": "string", "nullable": true }, "timeStamp": { "type": "string", "format": "date-time" }, "provisionState": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "isUnrecoverable": { "type": "boolean", "description": "When this property is TRUE, the provision or deprovision is stopped and the route is marked as incompleted.\r\nWhen this property is FALSE, that indicates a transient error and does not affect the provisioning state." } }, "additionalProperties": false }, "UpdateSubscriptionPayload": { "required": [ "description", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "azureSubscriptionId": { "type": "string", "format": "uuid" }, "azurePlanId": { "type": "string", "nullable": true }, "defaultRttMultiplier": { "type": "number", "description": "The default multiplier for the calculated latency between containers. (default value: 4)", "format": "double", "nullable": true }, "defaultEndpointExpirationInDays": { "type": "number", "description": "The number of days hublet endpoints are retained (by default) after the routes are stopped", "format": "double", "nullable": true } }, "additionalProperties": false }, "UpdateUserPreferencesRequestDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "deprecated": true }, "organizationId": { "type": "string", "nullable": true, "deprecated": true }, "personalOrganizationId": { "type": "string", "nullable": true, "deprecated": true }, "eTag": { "type": "string", "nullable": true, "deprecated": true }, "preferredLanguage": { "type": "string", "nullable": true }, "preferredTheme": { "$ref": "#/components/schemas/PreferredTheme" }, "preferredSubscriptionKey": { "$ref": "#/components/schemas/SubscriptionKey" } }, "additionalProperties": false, "description": "This class is used to replace UpdateUserRequestDTO.\r\nThe structure is the same, but some of the fields have been deprecated" }, "UserDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "eTag": { "type": "string", "nullable": true }, "preferredLanguage": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean", "description": "Represents if the document is enabled to operate." }, "isApplication": { "type": "boolean" }, "preferredTheme": { "$ref": "#/components/schemas/PreferredTheme" }, "organization": { "$ref": "#/components/schemas/OrganizationDTO" }, "personalOrganization": { "$ref": "#/components/schemas/OrganizationDTO" }, "preferredSubscription": { "$ref": "#/components/schemas/SubscriptionDTO" }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionDTO" }, "nullable": true }, "applicationRole": { "$ref": "#/components/schemas/RoleDTO" }, "identityProvider": { "type": "string", "nullable": true }, "identityUserFlow": { "$ref": "#/components/schemas/IdentityUserFlow" }, "isAdmin": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UserIdentity": { "type": "object", "properties": { "identityProvider": { "type": "string", "nullable": true }, "userFlow": { "$ref": "#/components/schemas/IdentityUserFlow" } }, "additionalProperties": false }, "UserInvitationDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "roleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserInvitationPayload": { "type": "object", "properties": { "emailAddress": { "type": "string", "nullable": true }, "roleId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Version": { "required": [ "major", "minor" ], "type": "object", "properties": { "major": { "type": "string" }, "minor": { "type": "string" } }, "additionalProperties": false }, "VersionInfo": { "required": [ "build", "major", "minor" ], "type": "object", "properties": { "major": { "type": "integer", "format": "int32" }, "minor": { "type": "integer", "format": "int32" }, "build": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "WowzaConnectionCodePayload": { "type": "object", "properties": { "connectionCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WowzaValidationResponseDTO": { "type": "object", "properties": { "streamId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "implicit": { "authorizationUrl": "https://haivisionb2c.b2clogin.com/haivisionb2c.onmicrosoft.com/oauth2/v2.0/authorize", "scopes": { "https://haivisionb2c.onmicrosoft.com/srthub-prod1-api/user_impersonation": "User Impersonation" } } } } } }, "security": [ { "oauth2": [ ] } ] }