Deployment
Create Deployment
Create a new deployment with the provided data.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
Header Parameters
X-API-Version*string
API contract version to target. See the Changelog for what changed in each version.
Default
"2.0.0"Value in
"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"Request Body
application/json
platform*string
Deployment platform.
Value in
"ANDROID" | "IOS" | "WINDOWS" | "MACOS" | "LINUX"version*string
Version number. Must not be greater than 191 characters.
file_url*string
URL to download the deployment file. Must be a valid URL.
release_notes?|
Release notes for this deployment.
new_features*array<>
improvements*array<>
bug_fixes*array<>
min_os_version?|
Minimum OS version required. Must not be greater than 50 characters.
max_os_version?|
Maximum OS version supported. Must not be greater than 50 characters.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:8000/api/v2/deployments" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "platform": "ANDROID", "version": "1.0.0", "file_url": "https://example.com/app-v1.0.0.apk", "new_features": [ "consequatur" ], "improvements": [ "est" ], "bug_fixes": [ "ut" ] }'{
"meta": {
"code": 200,
"status": "success",
"message": "Deployment created successfully."
},
"data": {
"platform": "MACOS",
"version": "6.47.48",
"file_url": "http://emard.com/",
"release_notes": "Quae facere occaecati sunt voluptates. Tempore sunt aut dolores dolorem mollitia.",
"min_os_version": "13.0",
"max_os_version": "18.0",
"new_features": [
"Ipsam sit eos ut voluptate sunt.",
"Eius voluptate et quidem commodi vitae.",
"Minus ex perferendis similique cumque eaque."
],
"improvements": [
"Soluta aspernatur eaque vel fuga est omnis.",
"Expedita natus architecto recusandae est et."
],
"bug_fixes": [
"Dolores aliquam animi numquam tempora quasi.",
"Tenetur sequi commodi mollitia repellat culpa sunt numquam dolor."
],
"created_at": 1782824835775,
"updated_at": 1782824835775,
"id": "4e615b69-0895-44a5-8ba7-52ab19af1543"
}
}{
"meta": {
"code": 401,
"status": "error",
"message": "Unauthenticated."
},
"data": null
}{
"meta": {
"code": 403,
"status": "error",
"message": "Unauthorized."
},
"data": null
}{
"meta": {
"code": 404,
"status": "error",
"message": "Resource not found."
},
"data": null
}{
"meta": {
"code": 422,
"status": "error",
"message": "The selected platform is invalid. (and 1 more error)"
},
"data": [
{
"code": 0,
"message": "The selected platform is invalid.",
"field": "platform"
},
{
"code": 0,
"message": "The file url must be a valid URL.",
"field": "file_url"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}