Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Update a store connection

Updates a store connection; a new credential replaces the stored one.

Updates a store connection; a new credential replaces the stored one.

  • Path PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/store_connections/store-connection
  • Scope billing:write
  • Effect write — a successful call changes state.
  • Collection store_connections
  • Query update_mask, allow_missing, validate_only

#Request

FieldTypeWhat it is
store_connectionStoreConnectionThe store connection to update; name identifies it. Required.
update_maskfield_maskThe fields to write; unset writes every populated field.
allow_missingboolCreate the store connection when it does not exist (declarative upsert).
validate_onlyboolValidate and return the result without writing anything.

#StoreConnection

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/store_connections/{store_connection}; by convention app-store or google-play.
metaResourceMetaResource metadata.
specStoreConnectionSpecDesired state. Required.

#ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

#StoreConnectionSpec

FieldTypeWhat it is
app_storeAppStoreConnectionThe App Store. One of the store group.
google_playGooglePlayConnectionGoogle Play. One of the store group.
allow_sandboxboolAccept purchases the store marks as sandbox or license-test. Off in production: a sandbox purchase is then refused.
require_account_tokenboolRefuse a purchase that does not carry the subject's account token (App Store appAccountToken, Play obfuscatedAccountId).

#AppStoreConnection

FieldTypeWhat it is
bundle_idsstring[]The apps' bundle ids. Required.
issuer_idstringThe App Store Connect issuer id. Required.
key_idstringThe In-App Purchase key id. Required.
private_keystringThe In-App Purchase key (.p8 PEM). Write-only: sealed on write, never returned; omit it on update to keep the stored key. Never returned again.
app_apple_idint64The app's Apple id, needed to verify production notifications.
account_token_prefixstringAn earlier appAccountToken scheme the app's shipped builds use: the token is UUIDv5 in the URL namespace of this prefix followed by the subject id (for example https://accounts.example.com/v2/). Tokens in Money's own scheme are always accepted as well.

#GooglePlayConnection

FieldTypeWhat it is
package_namesstring[]The apps' package names. Required.
service_account_jsonstringThe service account's JSON key. Write-only: sealed on write, never returned; omit it on update to keep the stored key. Never returned again.
notification_audiencestringThe audience Play's Pub/Sub push token must carry for real-time developer notifications; unset refuses them.
notification_service_accountstringThe service account Pub/Sub pushes as.

#Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/store_connections/{store_connection}; by convention app-store or google-play.
uidstringstc_<cell><ulid>; never reused. Store notifications for this connection are sent to a URL that carries it. Output only.
metaResourceMetaResource metadata.
specStoreConnectionSpecDesired state. Required.
statusStoreConnectionStatusObserved state. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#StoreConnectionSpec

FieldTypeWhat it is
app_storeAppStoreConnectionThe App Store. One of the store group.
google_playGooglePlayConnectionGoogle Play. One of the store group.
allow_sandboxboolAccept purchases the store marks as sandbox or license-test. Off in production: a sandbox purchase is then refused.
require_account_tokenboolRefuse a purchase that does not carry the subject's account token (App Store appAccountToken, Play obfuscatedAccountId).

#StoreConnectionStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready when a credential is stored. Output only.
credential_setboolWhether a credential is stored. Output only.
notification_urlstringWhere the store sends its notifications for this connection. Output only.
service_account_emailstringThe service account's email, read from the stored key (Play only). Output only.

#AppStoreConnection

FieldTypeWhat it is
bundle_idsstring[]The apps' bundle ids. Required.
issuer_idstringThe App Store Connect issuer id. Required.
key_idstringThe In-App Purchase key id. Required.
private_keystringThe In-App Purchase key (.p8 PEM). Write-only: sealed on write, never returned; omit it on update to keep the stored key. Never returned again.
app_apple_idint64The app's Apple id, needed to verify production notifications.
account_token_prefixstringAn earlier appAccountToken scheme the app's shipped builds use: the token is UUIDv5 in the URL namespace of this prefix followed by the subject id (for example https://accounts.example.com/v2/). Tokens in Money's own scheme are always accepted as well.

#GooglePlayConnection

FieldTypeWhat it is
package_namesstring[]The apps' package names. Required.
service_account_jsonstringThe service account's JSON key. Write-only: sealed on write, never returned; omit it on update to keep the stored key. Never returned again.
notification_audiencestringThe audience Play's Pub/Sub push token must carry for real-time developer notifications; unset refuses them.
notification_service_accountstringThe service account Pub/Sub pushes as.

#Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/store_connections/store-connection" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/envs/production/store_connections/store-connection","spec":{}}'