/application/configuration

Previous/application Next/auth

Last updated 18 days ago

Gets a Facebook Application Configuration

get

Gets a single Facebook application based on unique name or ID.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Facebook ApplicationConfiguration

delete

Deletes an existing Facebook Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a Firebase Application Configuration

get

Gets a single Firebase application based on unique name or ID.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Firebase ApplicationConfiguration

delete

Deletes an existing Firebase Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a Google Play Application Configuration

get

Gets a single Google Play application based on unique name or ID.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a Google Play ApplicationConfiguration

delete

Deletes an existing Google Play Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a iOS Application Configuration

get

Gets a single iOS application based on unique name or ID.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a iOS ApplicationConfiguration

delete

Deletes an existing iOS Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a PSN Application Configuration

get

Gets a single PSN application based on unique name or ID.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a PSN ApplicationConfiguration

delete

Deletes an existing PSN Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new iOS ApplicationConfiguration

post

Creates a new iOS ApplicationConfiguration with the specific ID or application.

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new Facebook ApplicationConfiguration

post

Creates a new Facebook ApplicationConfiguration with the specific ID or application.

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyrequired

The AppID as it appears in the Facebook Developer Console

applicationSecretanyrequired

The App Secret as it appears in the Facebook Developer Console

builtinApplicationPermissionsanyoptional

The set of built-in permissions connected clients will need to request.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null,
    "applicationSecret": null,
    "builtinApplicationPermissions": []
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Facebook ApplicationConfiguration

put

Updates an existing Facebook Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyrequired

The AppID as it appears in the Facebook Developer Console

applicationSecretanyrequired

The App Secret as it appears in the Facebook Developer Console

builtinApplicationPermissionsanyoptional

The set of built-in permissions connected clients will need to request.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null,
    "applicationSecret": null,
    "builtinApplicationPermissions": []
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new Firebase ApplicationConfiguration

post

Creates a new Firebase ApplicationConfiguration with the specific ID or application.

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

projectIdanyrequired

The contents of the serviceAccountCredentials.json file.

serviceAccountCredentialsanyrequired

The contents of the serviceAccountCredentials.json file.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "projectId": null,
    "serviceAccountCredentials": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Firebase ApplicationConfiguration

put

Updates an existing Firebase Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

projectIdanyrequired

The contents of the serviceAccountCredentials.json file.

serviceAccountCredentialsanyrequired

The contents of the serviceAccountCredentials.json file.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "projectId": null,
    "serviceAccountCredentials": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new Google Play ApplicationConfiguration

post

Creates a new GooglePlay ApplicationConfiguration with the specific ID or application.

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyoptional

jsonKeyanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null,
    "jsonKey": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Google Play ApplicationConfiguration

put

Updates an existing Google Play Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyoptional

jsonKeyanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null,
    "jsonKey": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a iOS ApplicationConfiguration

put

Updates an existing iOS Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "applicationId": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new PSN ApplicationConfiguration

post

Creates a new PSN ApplicationConfiguration with the specific ID or application.

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

npIdentifieranyrequired

Pattern: ^\S+$

clientSecretanyrequired

Pattern: ^\S+$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/psn' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "npIdentifier": null,
    "clientSecret": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a PSN ApplicationConfiguration

put

Updates an existing PSN Application profile if it is known to the server.

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Options: MATCHMAKING, PSN_PS4, PSN_VITA, IOS_APP_STORE, ANDROID_GOOGLE_PLAY, FACEBOOK, FIREBASE

uniqueIdentifieranyoptional

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parentobjectrequired

productBundlesanyoptional

The list of product bundles that may be rewarded upon successful IAP transactions.

npIdentifieranyrequired

Pattern: ^\S+$

clientSecretanyrequired

Pattern: ^\S+$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "category": "MATCHMAKING",
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "name": null,
      "description": null,
      "gitBranch": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "attributes": null,
      "applicationConfiguration": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": "[Circular Reference]"
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ],
        "metadata": null,
        "display": null
      }
    ],
    "npIdentifier": null,
    "clientSecret": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a Facebook Application Configuration

Deletes a Facebook ApplicationConfiguration

Gets a Firebase Application Configuration

Deletes a Firebase ApplicationConfiguration

Gets a Google Play Application Configuration

Deletes a Google Play ApplicationConfiguration

Gets a iOS Application Configuration

Deletes a iOS ApplicationConfiguration

Gets a PSN Application Configuration

Deletes a PSN ApplicationConfiguration

Creates a new iOS ApplicationConfiguration

Show child attributes

Creates a new Facebook ApplicationConfiguration

Show child attributes

Updates a Facebook ApplicationConfiguration

Show child attributes

Creates a new Firebase ApplicationConfiguration

Show child attributes

Updates a Firebase ApplicationConfiguration

Show child attributes

Creates a new Google Play ApplicationConfiguration

Show child attributes

Updates a Google Play ApplicationConfiguration

Show child attributes

Updates a iOS ApplicationConfiguration

Show child attributes

Creates a new PSN ApplicationConfiguration

Show child attributes

Updates a PSN ApplicationConfiguration

Show child attributes