Image Update Create URL parameters
Documentation for Image Update Create URL parameters
Read time 2 minutesLast updated 8 hours ago
AWS S3
s3://<username>:<password>@<bucket>/<folder>/?<parameters>
Authentication
Username = AWS Access Key Password = AWS SecretAccess Key https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.htmlOptional query parameters
Name | Description | Default |
handlers | Specifies the number of handlers used to sync the bucket | 10 |
region | Identifies the AWS region in which the bucket is located. | eu-west-1 |
requesttimeout | Specifies how long until the request fetching the image will wait before timeout. | 2m (2 minutes) |
Steamcmd
steam://<username>:<password>@install/<appid>/
Authentication
Username = Steam username (can be 'anonymous') Password = Steam password (can be blank if user is 'anonymous') Steam Guard Code = Refer to Optional query parameters forguardcodeOptional query parameters
Name | Description | Default |
platformtype | convar @sSteamCmdForcePlatformType - Valid options are | The Platform Type of your buildbox. Often there a misconfiguration of your steam repo if: Your buildbox matches the expected Platform And, you are still forcing this option. In this case check your app is correctly assigned to your depot. |
platformbitness | convar @sSteamCmdForcePlatformBitness - Valid options are | The Platform Bitness of your buildbox. (generally 64 bit nowadays) |
guardcode | Steam guard code passed to the login command | N/a |
beta | | N/a |
betapassword | | N/a |
appmod | | N/a |
Google Cloud Storage
gs://<bucket>/<folder>?credentials=<creds>
Authentication
Credentials which grant permission to the bucket. Must be URL-encoded Google Service Account JSON credentials. https://cloud.google.com/iam/docs/keys-create-deleteOptional Query Parameters
Name | Description | Default |
handlers | Specifies the number of handlers used to sync the bucket. | 10 |
requesttimeout | The timeout value used in the request. | Two minutes |
Tencent Cloud Object Storage
cos://<username>:<password>@<bucket>/<folder>
Authentication
Username = COS SecretId Password = COS SecretKey https://www.tencentcloud.com/document/product/436/45241?lang=enOptional Query Parameters
Name | Description | Default |
handlers | Specifies the number of handlers used to sync the bucket. | 10 |
region | Identifies the Tencent Cloud region in which the bucket is located. | |
requesttimeout | The timeout that the request will use. | 2m (Two Minutes) |
URL encoding caveats
You should URL-encode username and password credentials if they contain any special characters before encoding complete URLs (with the encoded credentials) separately; this is the same for every available URL type and must be done when making an API call with the URL parameter. Encoding does not need to be done when using the Clanforge WebPanel.AWS S3 URL encoding example
The following example explains how you would use the AWS S3 URL parameter with your Image Create Update API call and perform encoding. For example, you might have the following S3 URL:s3://my%user:my%password\@bucket/keymy%usermy%passwordmy%25usermy%25password- Build the S3 URL with the encoded credentials as follows: .
s3://my%25user:my%25password@bucket/key - Encode the entire URL (including the pre-encoded credentials) before using the bucket URL in an API request. After encoding, the entire bucket URL is .
s3%3A%2F%2Fmy%25user%3Amy%25password%40bucket%2Fkey - Finally, after performing the two-step encoding process, you can use the S3 bucket URL in an API request:
https://api.multiplay.co.uk/cfp/v1/imageupdate/create?imageid=1249&machineid=95394&accountserviceid=1337&desc=alpha-build&url=s3%3A%2F%2Fmy%25user%3Amy%25password%40bucket%2Fkey.`