Mobile Symbolication API - PUT pin files
Pin or unpin all symbolication files of a app version. A pinned file will not be deleted automtically, when running out of space.
The request produces an application/json
payload.
PUT |
|
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
applicationId | string |
The application id used in DESK of the app which should be (un)pinned |
path | required |
packageName | string |
The CFBundleIdentifier (iOS) or the package name (Android) which identifies the app associated with the files to be (un)pinned |
path | required |
os | string |
The operating system for which the files will be (un)pinned The os element can hold these values. |
path | required |
versionCode | string |
The version code (Android) / CFBundleVersion (iOS) the file belongs to |
path | required |
versionName | string |
The version name (Android) / CFBundleShortVersionString (iOS) the file belongs to |
path | required |
body | SymbolFilePinning |
JSON body of the request, containing the pinning status to set. |
body | optional |
The SymbolFilePinning object
Element | Type | Description | Required |
---|---|---|---|
pinned | boolean |
New setting for file pinning. True to pin the file, false to unpin the file |
required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"pinned": true
}
Possible values
Possible values for the os element:
- ANDROID
- IOS
- TVOS
Response format
A successful request doesn't return any content.
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json
payload.
PUT |
|
Response codes
Code | Description |
---|---|
204 | Validated. The submitted body is valid. Response does not have a body. |
400 | Failed. The input is invalid. |