RESTAPI:OpenAPICode1.10: Unterschied zwischen den Versionen

Aus Cryptshare Documentation
Wechseln zu:Navigation, Suche
(Die Seite wurde neu angelegt: „{"openapi":"3.0.1","info":{"title":"Cryptshare REST API","description":"REST API of Cryptshare Server, currently focussed on Cryptshare for OWA.","version":"1.10"},"servers":[{"url":"{protocol}://{host}/api","description":"The Cryptshare Server to use the API with.","variables":{"protocol":{"description":"The protocol of target Cryptshare Server.","default":"https"},"host":{"description":"The host of the target Cryptshare Server.","default":"localhost"}}}…“)
 
(Frorathm änderte das Inhaltsmodell der Seite RESTAPIBackend:OpenAPICode1.10 von „Wikitext“ nach „JSON“)
Markierung: Änderung des Inhaltsmodells
 
Zeile 1: Zeile 1:
{
{
"openapi": "3.0.1",
"info": {
"title": "Cryptshare REST API",
"description": "REST API of Cryptshare Server, currently focussed on Cryptshare for OWA.",
"version": "1.10"
},
"servers": [
{
"url": "{protocol}://{host}/api",
"description": "The Cryptshare Server to use the API with.",
"variables": {
"protocol": {
"description": "The protocol of target Cryptshare Server.",
"default": "https"
},
"host": {
"description": "The host of the target Cryptshare Server.",
"default": "localhost"
}
}
}
],
"tags": [
{
"name": "terms-of-use",
"description": "Operations to retrieve resources and information regarding the terms of use."
},
{
"name": "client",
"description": "Operations to initiate a REST API consumer client."
},
{
"name": "password",
"description": "Operations for generating, validating passwords and viewing the password requirements"
},
{
"name": "transfer-policy",
"description": "Operations to retrieve information about the transfer policy."
},
{
"name": "imprint",
"description": "Operations to get the product imprint."
},
{
"name": "transfer",
"description": "Operations to check existing transfers."
},
{
"name": "transfer-session",
"description": "Operations to create and access new transfers. Transfer sessions may only be modified using the same verification token they were created with."
},
{
"name": "cors",
"description": "Operation to retrieve CORS status for the requesting origin."
},
{
"name": "logging",
"description": "Operations to retrieve logging settings and perform remote logging."
},
{
"name": "language-packs",
"description": "Operations to retrieve language pack resources and information."
},
{
"name": "verification",
"description": "Operations to access user verification."
},
{
"name": "transfer-emails",
"description": "Operations to retrieve emails of existing transfers."
},
{
"name": "download",
"description": "Operations to download transfer information and files."
}
],
"paths": {
"/users/{email-address}/transfer-sessions/{tracking-id}/files/{file-id}/content": {
"put": {
"tags": [
"transfer-session"
],
"summary": "Puts raw binary data to a transfer file. If data was already written to this file, it can not be replaced. Clients may want to stream the data if fitting.",
"operationId": "putFile",
"parameters": [
{
"name": "email-address",
"in": "path",
"description": "User to send as.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tracking-id",
"in": "path",
"description": "The tracking ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "file-id",
"in": "path",
"description": "The file ID to write data for.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-CS-ProductKey",
"in": "header",
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).",
"schema": {
"type": "string",
"example": "api.rest"
}
},
{
"name": "X-CS-ClientId",
"in": "header",
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.",
"required": true,
"schema": {
"maxLength": 4000,
"minLength": 50,
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
}
},
{
"name": "X-CS-MajorApiVersion",
"in": "header",
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 1
}
},
{
"name": "X-CS-MinimumMinorApiVersion",
"in": "header",
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 10
}
}
],
"responses": {
"200": {
"description": "Ok."
},
"409": {
"description": "State failed.\n * 2002 - The file has already been uploaded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * 3011 - Recipient and sender combination rejected by policy.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"400": {
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"verification": []
}
]
}
},
"/users/{email-address}/verification/token": {
"post": {
"tags": [
"verification"
],
"summary": "Creates a verification token. Note that repeated access in quick succession may cause rate limiting.",
"operationId": "createVerificationToken",
"parameters": [
{
"name": "email-address",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-CS-ProductKey",
"in": "header",
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).",
"schema": {
"type": "string",
"example": "api.rest"
}
},
{
"name": "X-CS-ClientId",
"in": "header",
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.",
"required": true,
"schema": {
"maxLength": 4000,
"minLength": 50,
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
}
},
{
"name": "X-CS-MajorApiVersion",
"in": "header",
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 1
}
},
{
"name": "X-CS-MinimumMinorApiVersion",
"in": "header",
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 10
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestVerificationBody"
}
}
},
"required": true
},
"responses": {
"429": {
"description": "Too Many Requests.\n  * 2007 - Request rejected because there are too many requests at the same time",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseVerificationToken"
}
}
}
},
"400": {
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, mail).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * 3002 - Invalid verification data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"501": {
"description": "Server error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/users/{email-address}/verification/code/email": {
"post": {
"tags": [
"verification"
],
"summary": "Requests a sender verification verification code to be sent via mail. Note that repeated access in quick succession may cause rate limiting. Note that previously created verification codes may be invalidated. \nTo customize the locale of the mail, the 'Accept-Language' header can be used.",
"operationId": "generateVerificationCode",
"parameters": [
{
"name": "email-address",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-CS-ProductKey",
"in": "header",
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).",
"schema": {
"type": "string",
"example": "api.rest"
}
},
{
"name": "X-CS-ClientId",
"in": "header",
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.",
"required": true,
"schema": {
"maxLength": 4000,
"minLength": 50,
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
}
},
{
"name": "X-CS-MajorApiVersion",
"in": "header",
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 1
}
},
{
"name": "X-CS-MinimumMinorApiVersion",
"in": "header",
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 10
}
}
],
"responses": {
"429": {
"description": "Too Many Requests.\n  * 2007 - Request rejected because there are too many requests at the same time",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"200": {
"description": "OK."
},
"400": {
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, mail).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Email service is not reachable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"501": {
"description": "Server error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/users/{email-address}/transfers/{tracking-id}/emails/sent": {
"post": {
"tags": [
"transfer-emails"
],
"summary": "Creates a recipient notification email for the sender of the transfer.",
"operationId": "createRecipientEmailFromSendersPointOfView",
"parameters": [
{
"name": "email-address",
"in": "path",
"description": "The email address of the requesting user who initiated the transfer.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tracking-id",
"in": "path",
"description": "The tracking ID of the transfer.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-CS-ProductKey",
"in": "header",
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).",
"schema": {
"type": "string",
"example": "api.rest"
}
},
{
"name": "X-CS-ClientId",
"in": "header",
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.",
"required": true,
"schema": {
"maxLength": 4000,
"minLength": 50,
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
}
},
{
"name": "X-CS-MajorApiVersion",
"in": "header",
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 1
}
},
{
"name": "X-CS-MinimumMinorApiVersion",
"in": "header",
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 10
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipientEmailRequest"
}
}
}
},
"responses": {
"404": {
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.\n * 2003 - Transfer not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"200": {
"description": "The response contains the generated recipient notification, for the sender of the transfer.",
"content": {
"text/html;charset=UTF-8": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"400": {
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. email-address, tracking-id).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"verification": []
}
]
}
},
"/users/{email-address}/transfers/{tracking-id}/emails/sender": {
"post": {
"tags": [
"transfer-emails"
],
"summary": "Creates a sender notification email for the transfer.",
"operationId": "createSenderEmail",
"parameters": [
{
"name": "email-address",
"in": "path",
"description": "The email address of the requesting user who initiated the transfer.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tracking-id",
"in": "path",
"description": "The tracking-ID of the transfer.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-CS-ProductKey",
"in": "header",
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).",
"schema": {
"type": "string",
"example": "api.rest"
}
},
{
"name": "X-CS-ClientId",
"in": "header",
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.",
"required": true,
"schema": {
"maxLength": 4000,
"minLength": 50,
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
}
},
{
"name": "X-CS-MajorApiVersion",
"in": "header",
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 1
}
},
{
"name": "X-CS-MinimumMinorApiVersion",
"in": "header",
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"example": 10
}
}
],
"requestBody": {
"content": {
 

Aktuelle Version vom 1. August 2024, 07:18 Uhr

openapi"3.0.1"
info
title"Cryptshare REST API"
description"REST API of Cryptshare Server, currently focussed on Cryptshare for OWA."
version"1.10"
servers
url"{protocol}://{host}/api"
description"The Cryptshare Server to use the API with."
variables
protocol
description"The protocol of target Cryptshare Server."
default"https"
host
description"The host of the target Cryptshare Server."
default"localhost"
tags
name"terms-of-use"
description"Operations to retrieve resources and information regarding the terms of use."
name"client"
description"Operations to initiate a REST API consumer client."
name"password"
description"Operations for generating, validating passwords and viewing the password requirements"
name"transfer-policy"
description"Operations to retrieve information about the transfer policy."
name"imprint"
description"Operations to get the product imprint."
name"transfer"
description"Operations to check existing transfers."
name"transfer-session"
description"Operations to create and access new transfers. Transfer sessions may only be modified using the same verification token they were created with."
name"cors"
description"Operation to retrieve CORS status for the requesting origin."
name"logging"
description"Operations to retrieve logging settings and perform remote logging."
name"language-packs"
description"Operations to retrieve language pack resources and information."
name"verification"
description"Operations to access user verification."
name"transfer-emails"
description"Operations to retrieve emails of existing transfers."
name"download"
description"Operations to download transfer information and files."
paths
/users/{email-address}/transfer-sessions/{tracking-id}/files/{file-id}/content
put
tags
"transfer-session"
summary"Puts raw binary data to a transfer file. If data was already written to this file, it can not be replaced. Clients may want to stream the data if fitting."
operationId"putFile"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
schema
type"string"
name"file-id"
in"path"
description"The file ID to write data for."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"Ok."
409
description"State failed. * 2002 - The file has already been uploaded."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3011 - Recipient and sender combination rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/users/{email-address}/verification/token
post
tags
"verification"
summary"Creates a verification token. Note that repeated access in quick succession may cause rate limiting."
operationId"createVerificationToken"
parameters
name"email-address"
in"path"
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/RequestVerificationBody"
requiredtrue
responses
429
description"Too Many Requests. * 2007 - Request rejected because there are too many requests at the same time"
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseVerificationToken"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, mail)."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3002 - Invalid verification data."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
501
description"Server error occurred."
content
application/json
schema
$ref"#/components/schemas/Error"
/users/{email-address}/verification/code/email
post
tags
"verification"
summary"Requests a sender verification verification code to be sent via mail. Note that repeated access in quick succession may cause rate limiting. Note that previously created verification codes may be invalidated. To customize the locale of the mail, the 'Accept-Language' header can be used."
operationId"generateVerificationCode"
parameters
name"email-address"
in"path"
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
429
description"Too Many Requests. * 2007 - Request rejected because there are too many requests at the same time"
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"OK."
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, mail)."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
500
description"Email service is not reachable."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
501
description"Server error occurred."
content
application/json
schema
$ref"#/components/schemas/Error"
/users/{email-address}/transfers/{tracking-id}/emails/sent
post
tags
"transfer-emails"
summary"Creates a recipient notification email for the sender of the transfer."
operationId"createRecipientEmailFromSendersPointOfView"
parameters
name"email-address"
in"path"
description"The email address of the requesting user who initiated the transfer."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID of the transfer."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/RecipientEmailRequest"
responses
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported. * 2003 - Transfer not found."
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"The response contains the generated recipient notification, for the sender of the transfer."
content
text/html;charset=UTF-8
schema
type"string"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. email-address, tracking-id)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/users/{email-address}/transfers/{tracking-id}/emails/sender
post
tags
"transfer-emails"
summary"Creates a sender notification email for the transfer."
operationId"createSenderEmail"
parameters
name"email-address"
in"path"
description"The email address of the requesting user who initiated the transfer."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking-ID of the transfer."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/SenderEmailRequest"
responses
200
description"The response contains the generated sender notification email for the sender of the transfer."
content
text/html;charset=UTF-8
schema
type"string"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported. * 2003 - Transfer not found."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. email-address, tracking-id)."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3010 - Sender rejected by policy. * 3011 - Recipient and sender combination rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/users/{email-address}/transfers/{tracking-id}/emails/recipients/{transfer-id}
post
tags
"transfer-emails"
summary"Creates a recipient notification email for the transfer."
operationId"createRecipientEmail"
parameters
name"email-address"
in"path"
description"The email address of the requesting user who initiated the transfer."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID of the transfer."
requiredtrue
schema
type"string"
name"transfer-id"
in"path"
description"The transfer ID of the transfer."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/RecipientEmailRequest"
responses
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported. * 2003 - Transfer or recipient not found."
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"The response contains the generated recipient notification email for the recipient of the transfer."
content
text/html;charset=UTF-8
schema
type"string"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. email-address, tracking-id)."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3010 - Sender rejected by policy. * 3011 - Recipient and sender combination rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/users/{email-address}/transfer-sessions
post
tags
"transfer-session"
summary"Creates a new transfer session. Initial values for the sender and recipient languages can be set by using the 'Accept-Language' header."
operationId"createSession"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/TransferSessionCreationOptions"
requiredtrue
responses
201
description"Created the transfer session. The 'Location' header will contain the URL of the created session."
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3010 - Sender rejected by policy. * 3011 - Recipient and sender combination rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/users/{email-address}/transfer-sessions/{tracking-id}
get
tags
"transfer-session"
summary"Returns an existing transfer session. Note that all properties will be present."
operationId"getSession"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseTransferSessionTransferSecurityModeObject"
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
post
tags
"transfer-session"
summary"Submits an existing transfer session. Returns the location where the finalized transfer can be inspected"
operationId"finalizeSession"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. "
content
application/json
schema
$ref"#/components/schemas/Error"
409
description"Validation of parameters failed. * 2001 - Some given values cannot be applied due to transfer rule restrictions."
content
application/json
schema
$ref"#/components/schemas/Error"
201
description"Created."
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
delete
tags
"transfer-session"
summary"Deletes an existing transfer session."
operationId"deleteSession"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
204
description"No Content."
content
*/*
schema
$ref"#/components/schemas/ResponseVoid"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
patch
tags
"transfer-session"
summary"Edits an existing transfer session."
operationId"editSession"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/TransferSessionPatchable"
requiredtrue
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseTransferSessionTransferSecurityModeObject"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. "
content
application/json
schema
$ref"#/components/schemas/Error"
409
description"Validation of parameters failed. * 2001 - Some given values cannot be applied due to transfer rule restrictions."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/users/{email-address}/transfer-sessions/{tracking-id}/files
post
tags
"transfer-session"
summary"Creates a new transfer file."
operationId"createFile"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/TransferFileCreationOptions"
requiredtrue
responses
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3011 - Recipient and sender combination rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
201
description"Created the transfer file. The 'Location' header will contain the URL of the created file."
content
application/json
schema
$ref"#/components/schemas/ResponseTransferFileCreationOptions"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/users/{email-address}/transfer-policy
post
tags
"transfer-policy"
summary"Requests the policy for the user as sender and the given recipients."
operationId"requestPolicy"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/TransferPolicyRequest"
requiredtrue
responses
200
description"Success."
content
application/json
schema
$ref"#/components/schemas/ResponseTransferPolicyResult"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, email-address)."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3010 - Email address and (possibly) IP address of the sender is rejected by policy."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/password
get
tags
"password"
summary"Returns a generated, valid password."
operationId"generatePassword"
parameters
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponsePassword-Wrapper"
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
post
tags
"password"
summary"Requests the validation of a given password against the current password requirements."
operationId"validatePassword"
parameters
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/Password-Wrapper"
requiredtrue
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponsePasswordValidationResult"
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
/logs
post
tags
"logging"
summary"Creates a single log message on the Cryptshare Server for the purpose of remote logging."
operationId"addLogEvent"
parameters
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
description"The log entry to be logged remotely."
content
application/json
schema
type"array"
items
$ref"#/components/schemas/LogEntry"
requiredtrue
responses
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3004 - Remote logging not permitted."
content
application/json
schema
$ref"#/components/schemas/Error"
201
description"The resource was created successfully"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key)."
content
application/json
schema
$ref"#/components/schemas/Error"
/users/{email-address}/transfers/{tracking-id}
get
tags
"transfer"
summary"Returns the details of a given transfer for its sender, including processing errors."
operationId"getTransferDetails"
parameters
name"email-address"
in"path"
description"User that sent this transfer."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseTransferStatus"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
patch
tags
"transfer"
summary"Edit the transfer with the given tracking id. Currently only revoking is supported: Files of revoked transfers can not be viewed or downloaded anymore."
operationId"editTransfer"
parameters
name"email-address"
in"path"
description"User that sent this transfer."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
requestBody
content
application/json
schema
$ref"#/components/schemas/TransferModification"
requiredtrue
responses
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
409
description"Invalid state. * 2002 - The target transfer has an invalid state."
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"Transfer has been revoked successfully."
content
application/json
schema
$ref"#/components/schemas/ResponseTransferStatus"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/users/{email-address}/verification
get
tags
"verification"
summary"Returns if an active verification for the provided mail exists, and what verification methods are available."
operationId"getVerificationStatus"
parameters
name"email-address"
in"path"
requiredtrue
schema
type"string"
name"X-CS-VerificationToken"
in"header"
description"The verification token to check."
requiredfalse
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseVerificationStatus"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, mail)."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. * 3002 - Invalid verification data."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
501
description"Server error occurred."
content
application/json
schema
$ref"#/components/schemas/Error"
/users/{email-address}/transfers
get
tags
"transfer"
summary"Returns a list of transfers for this sender. The latest transfers are shown first. The transfer only contain the ID, the state, a link to the details."
operationId"getAllTransfers"
parameters
name"email-address"
in"path"
requiredtrue
schema
type"string"
name"page-size"
in"query"
description"Size of the page. Max number of transfers returned per page. Default page size: 10, maximum page size: 100."
requiredfalse
schema
type"integer"
format"int32"
default10
name"page"
in"query"
description"Pagination index, 1-indexed. Default page: 1."
requiredfalse
schema
type"integer"
format"int32"
default1
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseListTransferBasicInfoDto"
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
/transfers/{transfer-id}
get
tags
"download"
summary"Returns the transfer information."
operationId"getTransferInformation"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose information is requested."
requiredtrue
schema
type"string"
example"AATga41O4m"
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseTransferInfo"
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
/transfers/{transfer-id}/zip
get
tags
"download"
summary"Returns a ZIP file download stream including all transfer files of this transfer. To customize the locale of the checksums, the 'Accept-Language' header can be used."
operationId"downloadZip"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose files are requested."
requiredtrue
schema
type"string"
example"AATga41O4m"
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"include-checksum-file"
in"query"
description"If the checksum file from the checksum endpoint should be included in the ZIP file."
requiredfalse
schema
type"boolean"
defaultfalse
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"OK."
content
application/zip
schema
type"string"
format"binary"
/transfers/{transfer-id}/files
get
tags
"download"
summary"Returns the transfer files information. Note that the `href` of the returned transfer files additionally includes the general parameters that are usually sent via headers for convenience. If the password was specified, it is also included in the `href`."
operationId"getTransferFilesInformation"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose information is requested."
requiredtrue
schema
type"string"
example"AATga41O4m"
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseListTransferFile"
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
/transfers/{transfer-id}/files/{file-id}
get
tags
"download"
summary"Returns a file download stream for a transfer file."
operationId"downloadSingleFile"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose file is requested."
requiredtrue
schema
type"string"
example"AATga41O4m"
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"file-id"
in"path"
description"The file id of the file to download, retrieved from the files endpoint."
requiredtrue
schema
type"string"
example"rP1t0njzTR"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId or fileId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId, fileId)."
content
application/json
schema
$ref"#/components/schemas/Error"
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"OK."
content
application/octet-stream
schema
type"string"
format"binary"
/transfers/{transfer-id}/eml
get
tags
"download"
summary"Returns an EML file download stream including the confidential message with attachments embedded."
operationId"downloadEml"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose files are requested."
requiredtrue
schema
type"string"
example"AATga41O4m"
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"threshold"
in"query"
description"The threshold in megabytes for embedding attachments to the EML body."
requiredfalse
schema
type"integer"
format"int32"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"OK."
content
application/octet-stream
schema
type"string"
format"binary"
/transfers/{transfer-id}/checksums
get
tags
"download"
summary"Returns a CSV file download stream including the checksums of all files in the transfer. To customize the locale of the checksums, the 'Accept-Language' header can be used."
operationId"downloadChecksums"
parameters
name"transfer-id"
in"path"
description"The transfer ID of the transfer whose information is requested."
requiredtrue
schema
type"string"
example"AATga41O4m"
name"password"
in"query"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"X-CS-Password"
in"header"
description"The URL encoded password for the transfer (can be specified by query parameter or header)."
requiredfalse
schema
type"string"
example"passw0rd"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
text/csv
schema
type"string"
501
description"Server error occurred. * 5001 - Unsupported operation: QUICK * 5002 - Unsupported operation: eID"
content
application/json
schema
$ref"#/components/schemas/Error"
410
description"The requested entity is deleted with this request. * 2006 - Transfer is deleted with this request"
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 2005 - Specified entity is locked/blocked (e.g. Transfer locked) * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
401
description"Unauthorized. * 3003 - Wrong transfer password"
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. transferId)."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists (e.g. transferId does not exist) * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
/products/{product-key}/logging
get
tags
"logging"
summary"Returns the logging settings for the given product and client."
operationId"getLoggingSettings"
parameters
name"product-key"
in"path"
description"The product key of the product the logging settings are requested for."
requiredtrue
schema
type"string"
example"client.owa"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseLoggingSettings"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
/products/{product-key}/legal/terms-of-use
get
tags
"terms-of-use"
summary"Returns information about the provided terms of use."
operationId"getTermsOfUse"
parameters
name"product-key"
in"path"
description"The product key of the product whose terms of use are requested."
requiredtrue
schema
type"string"
example"api.rest"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseTermsOfUseInfo"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
/products/{product-key}/legal/imprint
get
tags
"imprint"
summary"Returns the imprint content."
operationId"getImprint"
parameters
name"product-key"
in"path"
description"The product key of the product whose imprint is requested."
requiredtrue
schema
type"string"
example"api.rest"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseImprint"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
/products/{product-key}/language-packs
get
tags
"language-packs"
summary"Returns a list of installed language packs for the specified product."
operationId"getAllLanguagePacks"
parameters
name"product-key"
in"path"
description"The product key of the product the language pack is requested for."
requiredtrue
schema
type"string"
example"api.rest"
name"major-version"
in"query"
description"The major-version of language packs. If specified, the returned list only contains language packs matching that version."
requiredfalse
schema
type"string"
example5
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK"
content
application/json
schema
$ref"#/components/schemas/ResponseListLanguagePack"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). "
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1005 - Invalid path variable (e.g. lp-Id). * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
/products/{product-key}/language-packs/{lp-id}
get
tags
"language-packs"
summary"Returns information (including download link) about a specific language pack"
operationId"getLanguagePack"
parameters
name"product-key"
in"path"
description"The product key of the product the language pack is requested for."
requiredtrue
schema
type"string"
example"api.rest"
name"lp-id"
in"path"
description"The ID of the specific language pack."
requiredtrue
schema
type"string"
example"en-US_2"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK"
content
application/json
schema
$ref"#/components/schemas/ResponseLanguagePack"
404
description"The requested resource was not found. * 1005 - Invalid path variable (e.g. lp-Id). * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid request parameter (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
/products/{product-key}/language-packs/{lp-id}/*/**
get
tags
"language-packs"
summary"Returns a resource (stream) of certain resource of a language pack."
operationId"getLanguagePackFile"
parameters
name"product-key"
in"path"
description"The product key of the product the language pack is requested for."
requiredtrue
schema
type"string"
example"api.rest"
name"lp-id"
in"path"
description"The ID of the specific language pack."
requiredtrue
schema
type"string"
example"en-US_2"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
404
description"The requested resource was not found. * 1005 - Invalid path variable (e.g. lp-Id). * 1006 - Specified endpoint does not exist. * 2003 - Specified entity does not exists * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"OK. Content type may be different, depending on the requested resource."
content
*/*
schema
type"array"
items
type"string"
format"byte"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
/products/{product-key}/cors
get
tags
"cors"
summary"Returns the CORS status for the given product and requesting origin."
operationId"getCorsStatus"
parameters
name"product-key"
in"path"
description"The product key of the product whose CORS status is requested."
requiredtrue
schema
type"string"
example"api.rest"
name"Origin"
in"header"
description"The origin header consists of scheme, host and port"
requiredtrue
schema
type"string"
example"https://cryptshare.com"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseCorsStatus"
400
description"A required query parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
/products/client.owa/settings
get
tags
"products"
summary"Returns the settings for the OWA add-in."
operationId"getSettings"
parameters
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseOwaSettings"
400
description"A required query parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey)."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
/password/requirements
get
tags
"password"
summary"Returns the currently active password requirements."
operationId"getPasswordRequirements"
parameters
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseArrayListPasswordValidationRule"
401
description"The client is not allowed to perform the requested operation. * 3002 - The provided verification token differs from the verification token used for patching the transfer."
content
application/json
schema
$ref"#/components/schemas/Error"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
/clients
get
tags
"client"
summary"Requests a generated client id that can be used for all operations that require a client id."
operationId"getVerificationStatus_1"
parameters
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ProductKey). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key)."
content
application/json
schema
$ref"#/components/schemas/Error"
200
description"OK."
content
application/json
schema
$ref"#/components/schemas/ResponseClientId"
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed."
content
application/json
schema
$ref"#/components/schemas/Error"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
/users/{email-address}/transfer-sessions/{tracking-id}/files/{file-id}
delete
tags
"transfer-session"
summary"Deletes an existing file from a transfer session."
operationId"deleteFile"
parameters
name"email-address"
in"path"
description"User to send as."
requiredtrue
schema
type"string"
name"tracking-id"
in"path"
description"The tracking ID."
requiredtrue
schema
type"string"
name"file-id"
in"path"
description"The file ID to delete."
requiredtrue
schema
type"string"
name"X-CS-ProductKey"
in"header"
description"The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key)."
schema
type"string"
example"api.rest"
name"X-CS-ClientId"
in"header"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
requiredtrue
schema
maxLength4000
minLength50
pattern"^[a-zA-Z0-9]+$"
type"string"
name"X-CS-MajorApiVersion"
in"header"
description"The major version of the API to use. Can also be specified by query parameter (major-api-version)."
requiredtrue
schema
minimum0
type"integer"
example1
name"X-CS-MinimumMinorApiVersion"
in"header"
description"The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version)."
requiredtrue
schema
minimum0
type"integer"
example10
responses
403
description"The client is not allowed to perform the requested operation. * 3001 - Product not licensed. "
content
application/json
schema
$ref"#/components/schemas/Error"
204
description"No Content."
content
*/*
schema
$ref"#/components/schemas/ResponseVoid"
404
description"The requested resource was not found. * 1006 - Specified endpoint does not exist. * 2004 - Specified version is not supported."
content
application/json
schema
$ref"#/components/schemas/Error"
400
description"A required parameter was not specified or a parameter had an invalid content. * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId). * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key). * 1005 - Invalid path variable (e.g. productKey, emailAddress)."
content
application/json
schema
$ref"#/components/schemas/Error"
security
verification
Leeres Array
components
schemas
Error
type"object"
properties
errorCode
type"integer"
description"Proprietary Cryptshare Server error code."
format"int32"
errorMessage
type"string"
description"Short description of the error code in English."
RequestVerificationBody
type"object"
properties
verificationCode
type"string"
description"Code that confirms this verification. Must be present unless requesting a verification using client-id."
ResponseVerificationToken
type"object"
properties
data
$ref"#/components/schemas/VerificationToken"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
VerificationToken
type"object"
properties
token
type"string"
description"The verification token"
validUntil
type"string"
description"The valid to date of the token. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
description"Main data of the response."
Recipient
required
"mail"
type"object"
properties
mail
maxLength200
minLength0
type"string"
description"The recipient email address."
description"The 'BCC' recipients."
RecipientEmailRequest
type"object"
properties
additionalRecipients
$ref"#/components/schemas/Recipients"
description"Content to replace in Email."
Recipients
required
"bcc"
"cc"
"to"
type"object"
properties
to
uniqueItemstrue
type"array"
description"The 'To' recipients."
items
$ref"#/components/schemas/Recipient"
cc
uniqueItemstrue
type"array"
description"The 'CC' recipients."
items
$ref"#/components/schemas/Recipient"
bcc
uniqueItemstrue
type"array"
description"The 'BCC' recipients."
items
$ref"#/components/schemas/Recipient"
description"The recipients of the transfer grouped by to, cc and bcc."
SenderEmailRequest
type"object"
properties
password
type"string"
description"Password to reflect in the email."
additionalRecipients
$ref"#/components/schemas/Recipients"
description"Contents to replace in Email."
Sender
required
"name"
"phone"
type"object"
properties
name
maxLength200
minLength0
type"string"
description"The sender name."
phone
maxLength200
minLength0
type"string"
description"The sender phone."
description"The sender of the transfer (without email)."
TransferSessionCreationOptions
required
"recipients"
"sender"
type"object"
properties
sender
$ref"#/components/schemas/Sender"
recipients
$ref"#/components/schemas/Recipients"
description"The options to use for the creation of the transfer."
TransferFileCreationOptions
required
"fileName"
"size"
type"object"
properties
fileName
maxLength4000
minLength0
type"string"
description"The name of the file."
size
minimum0
type"integer"
description"The file size in bytes. This may be provided to allow the server to give early feedback regarding exceeded size limits."
format"int64"
checksum
maxLength1024
minLength0
type"string"
description"The checksum of the file. This may be provided to check the file integrity during processing. For the used algorithm, see the corresponding transfer session."
example"737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15"
description"The options to use for the creation of the file."
ResponseTransferFileCreationOptions
type"object"
properties
data
$ref"#/components/schemas/TransferFileCreationOptions"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
TransferPolicyRequest
type"object"
properties
recipients
type"array"
writeOnlytrue
items
type"string"
description"The parameters to perform the policy request with."
FailedRecipient
type"object"
properties
emailAddress
type"string"
description"The email address of the failed recipient."
example"abc.def@example.com"
reason
type"string"
description"The reason of the denial of the recipient. Currently, only 'ADMINISTRATIVE_REASONS' is supported."
enum
"ADMINISTRATIVE_REASONS"
description"List of all recipients to which the given sender is not allowed to perform a transfer. This is only set if the transfer would not be allowed."
FileType
type"object"
properties
extension
type"string"
description"Extension of the file."
example"pdf"
mediaType
type"string"
description"Media type of the file."
example"application/pdf"
description"File types."
FileTypeFilterConfig
type"object"
properties
listMode
type"string"
description"Filter mode."
example"ALLOW"
enum
"ALLOW"
"DENY"
"ALLOW"
"DENY"
fileTypes
type"array"
description"File types."
items
$ref"#/components/schemas/FileType"
description"File type filter configuration."
ResponseTransferPolicyResult
type"object"
properties
data
$ref"#/components/schemas/TransferPolicyResult"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
SecurityModeConfigDto
type"object"
description"Configuration of the security mode. Depending on the type (see 'name' property) this is one of OneTimePasswordSecurityModeConfig (for 'ONE_TIME_PASSWORD'), QuickSecurityModeConfig (for 'QUICK'), or EidSecurityModeConfig (for 'EID')."
SecurityModeDtoSecurityModeConfigDto
type"object"
properties
name
type"string"
description"Name of the security mode."
enum
"ONE_TIME_PASSWORD"
"QUICK"
"EID"
config
$ref"#/components/schemas/SecurityModeConfigDto"
description"List of available security modes (OneTimePasswordSecurityMode, QuickSecurityMode, EidSecurityMode), ordered by priority. The first element is meant to be set as default by the client."
TransferPolicyResult
type"object"
properties
allowed
type"boolean"
description"Whether a transfer with the requested sender-recipient combination would be allowed or not. Please note that if the user isn't allowed as sender at all, the request would result in a error response instead."
exampletrue
settings
$ref"#/components/schemas/TransferPolicySettings"
failedRecipients
uniqueItemstrue
type"array"
description"List of all recipients to which the given sender is not allowed to perform a transfer. This is only set if the transfer would not be allowed."
items
$ref"#/components/schemas/FailedRecipient"
description"Main data of the response."
TransferPolicySettings
type"object"
properties
maxRetentionPeriod
type"integer"
description"Max. number of days the transfer is retrievable, starting at the transfer's provision time."
format"int64"
example30
maxTotalSize
type"integer"
description"Max. total size of all files in bytes."
format"int64"
example2147483648
showFileNamesDefault
type"boolean"
description"Default setting for showing file names in notifications and logs."
showFileNamesChangeable
type"boolean"
description"Specifies whether the showFileNamesDefault setting is changeable or not."
showZipFileContentDefault
type"boolean"
description"Default setting for showing file names within ZIP files in notifications and logs. This only has an effect if file names are shown in general."
sendDownloadNotificationsDefault
type"boolean"
description"Default setting for sending download notifications on file retrieval."
sendDownloadNotificationsChangeable
type"boolean"
description"Specifies whether the sendDownloadNotificationsDefault setting is changeable or not."
confidentialMessageAllowed
type"boolean"
description"Specifies whether a confidential message can be part of the transfer or not."
confidentialMessageRequired
type"boolean"
description"Specifies whether a confidential message has to be part of the transfer or not."
recipientNotificationEditable
type"boolean"
description"Specifies whether the recipient notification can be edited or not."
securityModes
type"array"
description"List of available security modes (OneTimePasswordSecurityMode, QuickSecurityMode, EidSecurityMode), ordered by priority. The first element is meant to be set as default by the client."
items
$ref"#/components/schemas/SecurityModeDtoSecurityModeConfigDto"
fileTypeFilterConfig
$ref"#/components/schemas/FileTypeFilterConfig"
description"The evaluated policy settings of the matching policy rules. This is only set the transfer would be allowed at all."
Password-Wrapper
required
"password"
type"object"
properties
password
type"string"
Details
type"object"
description"Details of the rule."
PasswordValidationResult
type"object"
properties
valid
type"boolean"
description"Whether the given password is valid."
rulesNotFulfilled
type"array"
description"List of rules that are not fulfilled by the given password"
items
$ref"#/components/schemas/PasswordValidationRule"
description"Results of the validation of a given password"
PasswordValidationRule
type"object"
properties
name
type"string"
description"Name of the rule."
details
$ref"#/components/schemas/Details"
description"Represents a rule a password has to fulfill to be valid"
ResponsePasswordValidationResult
type"object"
properties
data
$ref"#/components/schemas/PasswordValidationResult"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
LogEntry
type"object"
properties
timestamp
type"string"
description"ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
level
type"string"
description"Assumes a severity ordering as specified by RFC 5424."
enum
"trace"
"debug"
"info"
"warn"
"error"
message
type"string"
description"The log message."
TransferModification
required
"status"
type"object"
properties
status
$ref"#/components/schemas/TransferModificationStatus"
revocationOptions
$ref"#/components/schemas/TransferRevocationOptions"
TransferModificationStatus
required
"state"
type"object"
properties
state
type"string"
description"The state of the transfer. Currently, only DELETED_BY_REVOCATION is supported, which revokes the transfer."
example"DELETED_BY_REVOCATION"
enum
"ACTIVE"
"DELETED_BY_EXPIRATION"
"DELETED_BY_REVOCATION"
"DELETED_BY_ADMIN"
"DELETED_BY_SECURITY"
"PROCESSING"
"FAILED"
TransferRevocationOptions
type"object"
properties
notifySender
type"boolean"
description"Whether the sender of the transfer should be notified per email."
defaulttrue
notifyRecipients
type"boolean"
description"Whether the recipients of the transfer should be notified per email. "
defaulttrue
message
type"string"
description"Custom text for the message body for the notification emails. Supports Markdown."
example"# Header Text..."
description"Optional settings for patch requests that revoke the transfer."
DownloadDto
type"object"
properties
downloadDate
type"string"
description"The date of the download. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
retrievalMethod
type"string"
description"The method how the file was retrieved: Downloaded or viewed in Content Viewer."
enum
"DOWNLOADED"
"VIEWED"
description"The list of downloads of this file."
FileDownloadDto
type"object"
properties
id
type"string"
description"The file ID."
downloads
type"array"
description"The list of downloads of this file."
items
$ref"#/components/schemas/DownloadDto"
FileStatusDto
type"object"
properties
id
type"string"
description"The file ID."
removed
type"boolean"
description"If this file was removed."
removalCause
type"string"
description"A formatted text with details why this file was removed. May be null."
NotificationMailLinkDto
type"object"
properties
href
type"string"
description"The absolute path to the mail."
description"Link to the recipient notification mail"
RecipientStatusDto
type"object"
properties
mail
type"string"
description"The recipient email address."
downloadUrl
type"string"
description"The URL this recipient can use to access this transfer. This URL is meant to be used by a real user, not an API. This field is set to null only if the password mode is none and a different verification token is used than the one when this transfer was created with."
id
type"string"
description"The recipient transfer ID."
notificationFailed
type"boolean"
description"If notification of this recipient failed."
fileDownloads
uniqueItemstrue
type"array"
items
$ref"#/components/schemas/FileDownloadDto"
notificationMailLink
$ref"#/components/schemas/NotificationMailLinkDto"
ResponseTransferStatus
type"object"
properties
data
$ref"#/components/schemas/TransferStatus"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
SenderStatusDto
type"object"
properties
email
type"string"
description"The sender email address."
notificationFailed
type"boolean"
description"If notification of the sender failed."
notificationMailLink
$ref"#/components/schemas/NotificationMailLinkDto"
StatusDto
type"object"
properties
state
type"string"
description"The state of the transfer."
enum
"ACTIVE"
"DELETED_BY_EXPIRATION"
"DELETED_BY_REVOCATION"
"DELETED_BY_ADMIN"
"DELETED_BY_SECURITY"
"PROCESSING"
"FAILED"
warnings
type"boolean"
description"If any warnings were encountered. This could be for example files that were removed."
emlCreationFailed
type"boolean"
description"If the creation of the EML file failed."
sender
$ref"#/components/schemas/SenderStatusDto"
recipients
uniqueItemstrue
type"array"
items
$ref"#/components/schemas/RecipientStatusDto"
files
uniqueItemstrue
type"array"
items
$ref"#/components/schemas/FileStatusDto"
TransferNotificationMessage
type"object"
properties
subject
maxLength255
minLength0
pattern"^[^<>\\/#,\]\[}{%$~]*$"
type"string"
description"The subject of the transfer notification."
example"Hello from Cryptshare"
body
type"string"
description"The body of the transfer notification. May contain HTML."
description"The notification mail that will be sent to the recipients."
TransferSessionFile
type"object"
properties
id
type"string"
description"The ID of this file."
example"a58dFp1Tr7"
fileName
type"string"
description"The name of the file."
example"Invoice.pdf"
size
type"integer"
description"The file size in bytes."
format"int64"
example13987
checksum
type"string"
description"The checksum of the file."
example"737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15"
href
type"string"
description"The absolute path to the transfer file."
state
type"string"
description"The state of this file."
enum
"ACTIVE"
"INITIALIZED"
"UPLOADED"
"REMOVED"
description"The files of this transfer."
TransferSessionObject
type"object"
properties
sender
$ref"#/components/schemas/Sender"
recipients
$ref"#/components/schemas/Recipients"
expirationDate
type"string"
description"The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
securityMode
type"object"
description"The security mode for this transfer."
notificationMessage
$ref"#/components/schemas/TransferNotificationMessage"
senderLanguage
type"string"
description"The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
recipientLanguage
type"string"
description"The recipient language. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
showFileNames
type"boolean"
description"If file names should be shown in notification mails."
showZipFileContent
type"boolean"
description"If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false."
sendDownloadNotifications
type"boolean"
description"If notification mails should be sent to the sender when a file is downloaded."
sendDownloadSummary
type"boolean"
description"If a summary notification mail should be sent to the sender the transfer expires."
sendUploadSummary
type"boolean"
description"If a confirmation notification mail should be sent to the sender after the transfer is provided."
sendRecipientNotification
type"boolean"
description"If notification mails should be sent to the recipients after the transfer is provided."
classificationId
maxLength4000
minLength0
type"string"
description"An optional ID for the type of classification used for this transfer."
fileChecksumAlgorithm
maxLength50
minLength0
type"string"
description"The name of the hashing algorithm that will be used for files in this transfer."
example"SHA-256"
confidentialMessageFileId
type"string"
description"The file ID of the confidential message. May be null."
files
uniqueItemstrue
type"array"
description"The files of this transfer."
items
$ref"#/components/schemas/TransferSessionFile"
TransferStatus
type"object"
properties
transfer
$ref"#/components/schemas/TransferSessionObject"
status
$ref"#/components/schemas/StatusDto"
description"Main data of the response."
TransferOneTimePasswordSecurityMode
type"object"
allOf
$ref"#/components/schemas/TransferSecurityModeObject"
type"object"
properties
config
$ref"#/components/schemas/TransferOneTimePasswordSecurityModeConfig"
TransferOneTimePasswordSecurityModeConfig
type"object"
properties
passwordMode
type"string"
description"The password mode to use. Note that if 'GENERATED' is used, the password is calculated by the server."
enum
"MANUAL"
"GENERATED"
"NONE"
password
type"string"
description"The password for the transfer."
description"The configuration of the security mode."
TransferSecurityModeObject
type"object"
properties
name
type"string"
description"The identifier for this security mode."
enum
"ONE_TIME_PASSWORD"
config
type"object"
description"The configuration of the security mode."
description"Security mode. Possible implementations are: 'TransferOneTimePasswordSecurityMode'"
discriminator
propertyName"name"
TransferSessionPatchable
type"object"
properties
sender
$ref"#/components/schemas/Sender"
expirationDate
type"string"
description"The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
securityMode
oneOf
$ref"#/components/schemas/TransferOneTimePasswordSecurityMode"
notificationMessage
$ref"#/components/schemas/TransferNotificationMessage"
fileChecksumAlgorithm
maxLength50
minLength0
type"string"
description"The name of the hashing algorithm that will be used for files in this transfer."
example"SHA-256"
senderLanguage
type"string"
description"The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
recipientLanguage
type"string"
description"The recipient language. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
showFileNames
type"boolean"
description"If file names should be shown in notification mails."
showZipFileContent
type"boolean"
description"If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false."
sendDownloadNotifications
type"boolean"
description"If notification mails should be sent to the sender when a file is downloaded."
sendDownloadSummary
type"boolean"
description"If a summary notification mail should be sent to the sender the transfer expires."
sendUploadSummary
type"boolean"
description"If a confirmation notification mail should be sent to the sender after the transfer is provided."
sendRecipientNotification
type"boolean"
description"If notification mails should be sent to the recipients after the transfer is provided."
classificationId
maxLength4000
minLength0
type"string"
description"An optional ID for the type of classification used for this transfer."
confidentialMessageFileId
type"string"
description"The file ID of the confidential message. May be null."
ResponseTransferSessionTransferSecurityModeObject
type"object"
properties
data
$ref"#/components/schemas/TransferSessionTransferSecurityModeObject"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
TransferSessionTransferSecurityModeObject
type"object"
properties
sender
$ref"#/components/schemas/Sender"
recipients
$ref"#/components/schemas/Recipients"
expirationDate
type"string"
description"The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
securityMode
oneOf
$ref"#/components/schemas/TransferOneTimePasswordSecurityMode"
notificationMessage
$ref"#/components/schemas/TransferNotificationMessage"
senderLanguage
type"string"
description"The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
recipientLanguage
type"string"
description"The recipient language. IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en"
showFileNames
type"boolean"
description"If file names should be shown in notification mails."
showZipFileContent
type"boolean"
description"If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false."
sendDownloadNotifications
type"boolean"
description"If notification mails should be sent to the sender when a file is downloaded."
sendDownloadSummary
type"boolean"
description"If a summary notification mail should be sent to the sender the transfer expires."
sendUploadSummary
type"boolean"
description"If a confirmation notification mail should be sent to the sender after the transfer is provided."
sendRecipientNotification
type"boolean"
description"If notification mails should be sent to the recipients after the transfer is provided."
classificationId
maxLength4000
minLength0
type"string"
description"An optional ID for the type of classification used for this transfer."
fileChecksumAlgorithm
maxLength50
minLength0
type"string"
description"The name of the hashing algorithm that will be used for files in this transfer."
example"SHA-256"
confidentialMessageFileId
type"string"
description"The file ID of the confidential message. May be null."
files
uniqueItemstrue
type"array"
description"The files of this transfer."
items
$ref"#/components/schemas/TransferSessionFile"
description"Main data of the response."
ResponseVerificationStatus
type"object"
properties
data
$ref"#/components/schemas/VerificationStatus"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
VerificationStatus
type"object"
properties
validUntil
type"string"
description"The valid to date of the token. ISO 8601 with 'T' separator and numeric timezone."
example"2020-10-09T11:51:46+02:00"
verified
type"boolean"
description"The state if the client is verified for the specified email address."
exampletrue
verificationMethods
uniqueItemstrue
type"array"
description"A list of available verification methods."
items
type"string"
description"A list of available verification methods."
enum
"clientId"
"email"
"clientId"
"email"
enum
"clientId"
"email"
description"Main data of the response."
ResponseListTransferBasicInfoDto
type"object"
properties
data
type"array"
description"Main data of the response."
items
$ref"#/components/schemas/TransferBasicInfoDto"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
TransferBasicInfoDto
type"object"
properties
trackingId
type"string"
description"The tracking ID."
state
type"string"
description"The state of the transfer."
enum
"UNKNOWN"
"PENDING"
"ACTIVE"
"DELETED_BY_EXPIRATION"
"DELETED_BY_REVOCATION"
"DELETED_BY_ADMIN"
"DELETED_BY_SECURITY"
"PROCESSING"
"FAILED"
recipients
uniqueItemstrue
type"array"
items
$ref"#/components/schemas/RecipientStatusDto"
href
type"string"
description"The absolute path to the transfer."
description"Main data of the response."
ResponseTransferInfo
type"object"
properties
data
$ref"#/components/schemas/TransferInfo"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
TransferInfo
type"object"
properties
totalSize
type"integer"
description"The total file size in bytes."
format"int64"
example13987
checksumAlgorithm
type"string"
description"The checksum algorithm used for checksum generation."
example"SHA-256"
description"Main data of the response."
ResponseListTransferFile
type"object"
properties
data
type"array"
description"Main data of the response."
items
$ref"#/components/schemas/TransferFile"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
TransferFile
type"object"
properties
id
type"string"
description"The ID of this file."
example"a58dFp1Tr7"
fileName
type"string"
description"The name of the file."
example"Invoice.pdf"
size
type"integer"
description"The file size in bytes."
format"int64"
example13987
checksum
type"string"
description"The checksum of the file."
example"737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15"
href
type"string"
description"The absolute path to the transfer file."
description"Main data of the response."
LoggingSettings
type"object"
properties
level
type"string"
description"Assumes a severity ordering as specified by RFC 5424."
enum
"trace"
"debug"
"info"
"warn"
"error"
remoteLoggingEnabled
type"boolean"
description"Specifies whether the requesting client should send its log entries to the Cryptshare Server."
exampletrue
description"Main data of the response."
ResponseLoggingSettings
type"object"
properties
data
$ref"#/components/schemas/LoggingSettings"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
ResponseTermsOfUseInfo
type"object"
properties
data
$ref"#/components/schemas/TermsOfUseInfo"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
TermsOfUse
type"object"
properties
locale
type"string"
description"IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en-US"
title
type"string"
description"Title of the terms of use, in the respective language."
example"Cryptshare at ACME Inc., Terms of Use"
content
type"string"
description"Either an URL pointing to the terms of use (type 'link') or the content of the terms of use itself (type 'html')"
example"<p>The terms of use!</p>"
type
type"string"
description"Specifies the value type of the content property."
example"html"
enum
"link"
"html"
description"The terms of use in specific languages."
TermsOfUseInfo
type"object"
properties
active
type"boolean"
description"Specifies whether terms of use are active or not. Active terms of use need to be accepted by users before first usage of the product or whenever terms are changed."
exampletrue
lastChangeTimestamp
type"string"
description"The date and time of the last change of the terms of use, or null, if the terms of use have never been changed. Format: ISO 8601 with 'T' separator and numeric timezone."
nullabletrue
example"2020-10-09T11:51:46+02:00"
terms
type"array"
description"The terms of use in specific languages."
items
$ref"#/components/schemas/TermsOfUse"
description"Main data of the response."
Imprint
type"object"
properties
content
type"string"
description"Either an URL pointing to the imprint (type 'link') or the content itself (type 'html')."
example"<h1>Imprint</h1><p>Lorem ipsum...</p>"
type
type"string"
description"Specifies value type of the content property.."
example"html"
enum
"link"
"html"
description"Main data of the response."
ResponseImprint
type"object"
properties
data
$ref"#/components/schemas/Imprint"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
LanguagePack
type"object"
properties
id
type"string"
description"Id of the language pack, contains locale and major version."
example"en-US_2"
displayName
type"string"
description"The display name of the language, in the respective language."
example"English (US)"
locale
type"string"
description"IETF BCP 47 language tag, RFC 5646. Format: &lt;language&gt;[-&lt;region&gt;]. Case insensitive."
example"en-US"
version
type"string"
description"The version of the language pack, consisting of major and minor version."
example"2.1"
lastChangeTimestamp
type"string"
description"The date and time of the last update of the language pack, or null, if it was never updated. Format: ISO 8601 with 'T' separator and numeric timezone."
nullabletrue
example"2020-10-09T11:51:46+02:00"
href
type"string"
description"The absolute path to the language pack resources."
example"/api/products/api.rest/language-packs/en-US_2"
description"Main data of the response."
ResponseListLanguagePack
type"object"
properties
data
type"array"
description"Main data of the response."
items
$ref"#/components/schemas/LanguagePack"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
ResponseLanguagePack
type"object"
properties
data
$ref"#/components/schemas/LanguagePack"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
CorsStatus
type"object"
properties
active
type"boolean"
description"Specifies whether CORS is active or not for requesting origin"
exampletrue
description"Main data of the response."
ResponseCorsStatus
type"object"
properties
data
$ref"#/components/schemas/CorsStatus"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
MicrosoftGraphSettings
type"object"
properties
applicationId
type"string"
description"The application ID."
authority
type"string"
description"The authority."
description"Microsoft Graph settings."
OwaSettings
type"object"
properties
microsoftGraphSettings
$ref"#/components/schemas/MicrosoftGraphSettings"
description"Settings for Cryptshare for OWA."
ResponseOwaSettings
type"object"
properties
data
$ref"#/components/schemas/OwaSettings"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
ResponsePassword-Wrapper
type"object"
properties
data
$ref"#/components/schemas/Password-Wrapper"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
ResponseArrayListPasswordValidationRule
type"object"
properties
data
type"array"
description"Main data of the response."
items
$ref"#/components/schemas/PasswordValidationRule"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
ClientId
type"object"
properties
clientId
type"string"
description"The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential."
description"Main data of the response."
ResponseClientId
type"object"
properties
data
$ref"#/components/schemas/ClientId"
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
ResponseVoid
type"object"
properties
data
type"object"
description"Main data of the response."
meta
type"object"
additionalProperties
type"object"
description"Additional response metadata."
description"Additional response metadata."
securitySchemes
verification
type"apiKey"
description"Verification token. Can also be specified by query parameter (verification-token)."
name"X-CS-VerificationToken"
in"header"
Abgerufen von „https://documentation.cryptshare.com/w/index.php?title=RESTAPI:OpenAPICode1.10&oldid=43251“