Flavours API
Deployment

Create Deployment

POST
/api/v2/deployments

Create a new deployment with the provided data.

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 "https://api.flavours.sa/dev/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": [      "incidunt"    ],    "improvements": [      "quia"    ],    "bug_fixes": [      "qui"    ]  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Deployment created successfully."
  },
  "data": {
    "platform": "MACOS",
    "version": "3.16.75",
    "file_url": "http://www.fritsch.info/dolores-aliquam-est-aperiam-tempora-doloremque-sapiente-ut.html",
    "release_notes": "Commodi ad dolores repudiandae velit non et earum sapiente. Dolorem omnis magnam illum quidem facilis. Perspiciatis veniam omnis tempore suscipit perspiciatis omnis sequi. Maxime adipisci ipsum nostrum magnam.",
    "min_os_version": "11.0",
    "max_os_version": "16.0",
    "new_features": [
      "Esse cupiditate saepe corrupti ut officiis.",
      "Et eos ea hic ad.",
      "Aut non accusantium placeat quae cumque quo nulla dignissimos."
    ],
    "improvements": [
      "Vero aliquam harum omnis ut magnam quidem quo.",
      "Ullam natus quo ipsum deserunt temporibus nam reprehenderit autem."
    ],
    "bug_fixes": [
      "Eligendi quia nobis aperiam.",
      "Officiis id sed sunt itaque et."
    ],
    "id": "cff073e0-f986-4285-ab09-57566d7b6285",
    "created_at": 1787446693446,
    "updated_at": 1787446693446
  }
}
{
  "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 2 more errors)"
  },
  "data": [
    {
      "code": 0,
      "message": "The selected platform is invalid.",
      "field": "platform"
    },
    {
      "code": 0,
      "message": "The version must not be greater than 191 characters.",
      "field": "version"
    },
    {
      "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
}