Project

Operations related to projects.

Set organizations project status

post
/organizations/{organizationId}/projects/{projectId}/activate

Set organizations project status by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
post
/organizations/{organizationId}/projects/{projectId}/activate

Set organizations project status

post
/organizations/{organizationId}/projects/{projectId}/deactivate

Set organizations project status by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
post
/organizations/{organizationId}/projects/{projectId}/deactivate

Get organizations project credential

get
/organizations/{organizationId}/projects/{projectId}/credential

Get organizations project credential by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/credential

Update organizations project credential

patch
/organizations/{organizationId}/projects/{projectId}/credential

Update organizations project credential by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
Responses
chevron-right
200

OK

application/json
patch
/organizations/{organizationId}/projects/{projectId}/credential

Get organizations project unsafe credential

get
/organizations/{organizationId}/projects/{projectId}/credential/show-password/{name}

Get organizations project unsafe credential by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
namestringRequired

Credential name, formatted as (..)

Example: android.staging.keyPassword
Responses
chevron-right
200

OK

application/json
Responsestring
get
/organizations/{organizationId}/projects/{projectId}/credential/show-password/{name}

Update organizations project credential file

patch
/organizations/{organizationId}/projects/{projectId}/credential/file

Update organizations project credential file by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
osstring · enumRequired

Deployment OS

Example: <os>Possible values:
buildTargetstring · enumRequired

Deployment build target

Example: <buildTarget>Possible values:
provisioningProfilestringOptional

Deployment provisioning profile s3 url

Example: https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).mobileprovision
keystorestringOptional

Deployment keystore s3 url

Example: https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/1d5c0b7e-c098-40f4-b6e2-9256bd5b9fa4_d53a3d0f-82e6-4df4-bd65-855c25bd5e73_74b184f9-22d5-49ab-a58d-73ee7931a704_akinon-test-(6).keystore
Responses
chevron-right
200

OK

application/json
patch
/organizations/{organizationId}/projects/{projectId}/credential/file

Get organizations project credential validation

get
/organizations/{organizationId}/projects/{projectId}/credential/validation

Get organizations project credential validation by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/credential/validation

Get organizations projects

get
/organizations/{organizationId}/projects

Get organizations projects by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
statusstring · enumOptional

Project status

Possible values:
limitintegerOptional

The limit of per page

Default: 10
sortstringOptional

Sort

Example: {"value":"createdAt"}
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects

Create a organization project

post
/organizations/{organizationId}/projects

Create a organization project by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
namestringRequired

Project name

Example: <name>
descriptionstringOptional

Project description

Example: <description>
Responses
post
/organizations/{organizationId}/projects

Get a organization project

get
/organizations/{organizationId}/projects/{projectId}

Get a organization project by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}

Update a organization project

patch
/organizations/{organizationId}/projects/{projectId}

Update a organization project by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
appIconUrlstringOptional

Project app icon URL

Responses
chevron-right
200

OK

application/json
patch
/organizations/{organizationId}/projects/{projectId}

Force to update a project

post
/organizations/{organizationId}/projects/{projectId}/force-update

Force to update a project by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
forceUpdatebooleanRequired

Project force update

Example: <forceUpdate>
buildIdsstring[]Required

Entity ID

Responses
post
/organizations/{organizationId}/projects/{projectId}/force-update

No content

Get organizations project git repository

get
/organizations/{organizationId}/projects/{projectId}/git-repository

Get organizations project git repository by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/git-repository

Get organizations project artifact download url

get
/organizations/{organizationId}/projects/{projectId}/artifacts/download

Get organizations project artifact download url by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
urlstringRequired

Url

fileNamestringOptional

File name

Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/artifacts/download

Get organizations project credential download url

get
/organizations/{organizationId}/projects/{projectId}/credentials/download

Get organizations project credential download url by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
urlstringRequired

Url

fileNamestringOptional

File name

Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/credentials/download

Get a organization project additional credentials

get
/organizations/{organizationId}/projects/{projectId}/additional-credentials

Get a organization project additional credentials by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/additional-credentials

Create a organization project additional credential

post
/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}

Create a organization project additional credential by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
platformstring · enumRequired

Platform

Possible values:
envstring · enumRequired

Env

Possible values:
Body
provisioningProfilestringRequired

Deployment provisioning profile s3 url

Example: https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).mobileprovision
bundleIdentifierstringRequired

Deployment bundle identifier

Example: com.akinon.test
Responses
post
/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}

Delete a organization project additional credential

delete
/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier}

Delete a organization project additional credential by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
platformstring · enumRequired

Platform

Possible values:
envstring · enumRequired

Env

Possible values:
bundleIdentifierstringRequired

Bundle identifier

Responses
delete
/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier}

No content

Update a organization project additional credential

patch
/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier}

Update a organization project additional credential by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
platformstring · enumRequired

Platform

Possible values:
envstring · enumRequired

Env

Possible values:
bundleIdentifierstringRequired

Bundle identifier

Body
provisioningProfilestringOptional

Deployment provisioning profile s3 url

Example: https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).mobileprovision
bundleIdentifierstringOptional

Deployment bundle identifier

Example: com.akinon.test
Responses
chevron-right
200

OK

application/json
patch
/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier}

Create a organization project deployment

post
/organizations/{organizationId}/projects/{projectId}/deployments

Create a organization project deployment by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
userstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
statusstring · enumRequired

Deployment status

Example: <status>Possible values:
descriptionstringOptional

Deployment description

Example: <description>
tagstringRequired

Deployment tag

Example: <tag>
deploymentTypestring · enumRequired

Deployment type

Possible values:
buildTargetstring · enumRequired

Deployment build target

Possible values:
forceUpdatebooleanOptional

Deployment force update

Default: falseExample: <forceUpdate>
osstring · enumRequired

Deployment os

Possible values:
parentstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
isMandatorybooleanOptional

Deployment mandatory

Default: falseExample: <isMandatory>
targetBinaryRangestringOptional

Deployment target binary range

Example: <targetBinaryRange>
Responses
post
/organizations/{organizationId}/projects/{projectId}/deployments

Update a organization project deployment

patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}

Update a organization project deployment by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
statusstring · enumOptional

Deployment status

Example: <status>Possible values:
stageany ofOptional
stringOptional

Deployment stage

Example: <stage>
or
string[]Optional

Deployment stages

Example: <stage>
checksumstringOptional

Deployment package checksum

Example: <checksum>
sizenumberOptional

Deployment package size in bytes

Example: <size>
uploadDurationnumberOptional

Deployment upload duration in seconds

Example: <uploadDuration>
remoteIdnumberOptional

Deployment build service id

Example: <remoteId>
labelstringOptional

Deployment code push label

Example: <label>
isDisabledbooleanOptional

Deployment code push is disabled

Example: <isDisabled>
rolloutnumber · max: 100Optional

Deployment code push rollout

Example: <rollout>
releaseMethodstring · enumOptional

Deployment code push release method

Example: <releaseMethod>Possible values:
xcodeVersionstringOptional

Deployment xcode version

Example: <xcodeVersion>
extensionsstring[]Optional

Ios app extensions

Example: <extension>
javaVersionstringOptional

Java version for android and huawei

Example: <javaVersion>
versionCodenumberOptional

Deployment version code

Example: <versionCode>
envVersionstringOptional

Deployment env version

Example: <envVersion>
storeVersionstringOptional

Deployment store version

Example: <storeVersion>
isOnStorestring · enumOptional

Deployment is on store

Example: <isOnStore>Possible values:
Responses
chevron-right
200

OK

application/json
Responseone of
or
patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}

Get a organization project deployment timeline

get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/timeline

Get a organization project deployment timeline by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/timeline

Get organizations project store credentials

get
/organizations/{organizationId}/projects/{projectId}/store-credentials

Get organizations project store credentials by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

Entity ID

No content

get
/organizations/{organizationId}/projects/{projectId}/store-credentials

No content

Get organizations project store credential validation

get
/organizations/{organizationId}/projects/{projectId}/store-credentials/validation

Get organizations project store credential validation by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/store-credentials/validation

Update a project apple app store credential

patch
/organizations/{organizationId}/projects/{projectId}/store-credentials/apple-app-store

Update a project apple app store credential by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
keyIdstringOptional

Apple key id

Example: <keyId>
keyIssuerIdstringOptional

Apple issuer id

Example: <keyIssuerId>
apiKeyFilestringOptional

Apple api key p8 file s3 url

Example: <apiKeyFile>
keyInHousebooleanOptional

Apple key in house

Default: falseExample: <keyInHouse>
appIdentifierstringOptional

Apple app identifier

Example: <appIdentifier>
teamIdstringOptional

Apple team id

Example: <teamId>
teamNamestringOptional

Apple team name

Example: <teamName>
appSpecificIdstringOptional

Apple app specific id

Example: <appSpecificId>
Responses
chevron-right
200

OK

application/json
patch
/organizations/{organizationId}/projects/{projectId}/store-credentials/apple-app-store

Update a project google play credential

patch
/organizations/{organizationId}/projects/{projectId}/store-credentials/google-play

Update a project google play credential by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
googleServiceFilestringOptional

Google Play service file url

packageNamestringOptional

Google Play package name

Example: <packageName>
Responses
chevron-right
200

OK

application/json
patch
/organizations/{organizationId}/projects/{projectId}/store-credentials/google-play

Last updated

Was this helpful?