Skip to main content

Asset v1.0

Operations supporting organization,application assets, that are stored on the application (setup by the customer) storage.

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

Assets

Asset Controller

Find assets by application id

GET https://auvious.video:443/rtc-api/assets?applicationId=string HTTP/1.1
Host: auvious.video:443
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
applicationIdquerystringtrueapplicationId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKIterable«AssetInfo»
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{}
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X GET https://auvious.video:443/rtc-api/assets?applicationId=string \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

get a builtin signed url

GET https://auvious.video:443/rtc-api/assets/signed/{assetId}/{expiration}?signature=string HTTP/1.1
Host: auvious.video:443
Accept: */*

Parameters

ParameterInTypeRequiredDescription
assetIdpathstringtrueassetId
expirationpathinteger(int64)trueexpiration
signaturequerystringtruesignature

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Response Schema
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X GET https://auvious.video:443/rtc-api/assets/signed/{assetId}/{expiration}?signature=string \
-H 'Accept: */*' \ -H 'Authorization: Bearer {access-token}'

Upload an asset

POST https://auvious.video:443/rtc-api/assets/{assetId} HTTP/1.1
Host: auvious.video:443
Content-Type: multipart/form-data
X-Auvious-TransactionId: string

Request body

applicationId: string
category: string
file: string
rolesAllowedAccess: string

Parameters

ParameterInTypeRequiredDescription
assetIdpathstringtrueassetId
X-Auvious-TransactionIdheaderstringfalseused for detecting retries of the same request
bodybodyobjectfalsenone
» applicationIdbodystringtrueapplicationId
» categorybodystringtruecategory
» filebodystring(binary)truefile
» rolesAllowedAccessbodystringtruecomma separated list of roles allowed to access the asset, e.g.: admin,customer

Responses

Overview
StatusMeaningDescriptionSchema
201CreatedCreatedNone
204No ContentNo ContentNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X POST https://auvious.video:443/rtc-api/assets/{assetId} \
-H 'Content-Type: multipart/form-data' \ -H 'X-Auvious-TransactionId: string' \ -H 'Authorization: Bearer {access-token}'

Delete an asset

DELETE https://auvious.video:443/rtc-api/assets/{assetId} HTTP/1.1
Host: auvious.video:443
X-Auvious-TransactionId: string

Parameters

ParameterInTypeRequiredDescription
assetIdpathstringtrueid of asset to delete
X-Auvious-TransactionIdheaderstringfalseOptional header used for detecting retries of the same request

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentNo ContentNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X DELETE https://auvious.video:443/rtc-api/assets/{assetId} \
-H 'X-Auvious-TransactionId: string' \ -H 'Authorization: Bearer {access-token}'

create a signed url

POST https://auvious.video:443/rtc-api/assets/{assetId}/signedUrl HTTP/1.1
Host: auvious.video:443
Accept: application/json
X-Auvious-CreateInternalSignedUrl: true
Referer: string

Parameters

ParameterInTypeRequiredDescription
assetIdpathstringtrueassetId
X-Auvious-CreateInternalSignedUrlheaderbooleanfalseX-Auvious-CreateInternalSignedUrl
RefererheaderstringtrueReferer

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKSignedUrl
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{
"url": "string",
"validUntil": "2019-08-24T14:15:22Z"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X POST https://auvious.video:443/rtc-api/assets/{assetId}/signedUrl \
-H 'Accept: application/json' \ -H 'X-Auvious-CreateInternalSignedUrl: true' \ -H 'Referer: string' \ -H 'Authorization: Bearer {access-token}'

Schemas

AssetInfo

{
"assetId": "string",
"category": "string",
"rolesAllowedAccess": [
"ADMIN"
]
}

AssetInfo

Properties

NameTypeRequiredRestrictionsDescription
assetIdstringfalsenonenone
categorystringfalsenonenone
rolesAllowedAccess[string]falsenonenone

Iterable«AssetInfo»

{}

Iterable«AssetInfo»

Properties

None

SignedUrl

{
"url": "string",
"validUntil": "2019-08-24T14:15:22Z"
}

SignedUrl

Properties

NameTypeRequiredRestrictionsDescription
urlstring(url)falsenonenone
validUntilstring(date-time)falsenonenone