/application/configuration

Previous/application Next/auth

Last updated 1 month 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

objectoptional

application/json

get

GET /api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

objectoptional

application/json

delete

DELETE /api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

objectoptional

application/json

get

GET /api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

objectoptional

application/json

delete

DELETE /api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

objectoptional

application/json

get

GET /api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

objectoptional

application/json

delete

DELETE /api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

objectoptional

application/json

get

GET /api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

objectoptional

application/json

delete

DELETE /api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

objectoptional

application/json

get

GET /api/rest/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

objectoptional

application/json

delete

DELETE /api/rest/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "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

Configuration for the iOS Application Configuration

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Available options:

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

objectoptional

application/json

post

POST /api/rest/application/{applicationNameOrId}/configuration/ios HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1384

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "applicationId": null
}

{
  "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

Houses the various parameters required which allow communication with the Faceook API. The Facebook API will

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Available options:

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

objectoptional

application/json

post

POST /api/rest/application/{applicationNameOrId}/configuration/facebook HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1444

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "applicationId": null,
  "applicationSecret": null,
  "builtinApplicationPermissions": []
}

{
  "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

Houses the various parameters required which allow communication with the Faceook API. The Facebook API will

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Available options:

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

objectoptional

application/json

put

PUT /api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1444

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "applicationId": null,
  "applicationSecret": null,
  "builtinApplicationPermissions": []
}

{
  "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.

Available options:

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

objectoptional

application/json

post

POST /api/rest/application/{applicationNameOrId}/configuration/firebase HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1413

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "projectId": null,
  "serviceAccountCredentials": null
}

{
  "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.

Available options:

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

objectoptional

application/json

put

PUT /api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1413

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "projectId": null,
  "serviceAccountCredentials": null
}

{
  "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.

Available options:

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

objectoptional

application/json

post

POST /api/rest/application/{applicationNameOrId}/configuration/google_play HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1399

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "applicationId": null,
  "jsonKey": null
}

{
  "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.

Available options:

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

objectoptional

application/json

put

PUT /api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1399

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "applicationId": null,
  "jsonKey": null
}

{
  "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

Configuration for the iOS Application Configuration

idanyoptional

The database assigned ID for the application configuration.

categoryundefined · enumrequired

The category for the application configuration.

Available options:

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

objectoptional

application/json

put

PUT /api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1384

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "applicationId": null
}

{
  "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.

Available options:

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.

npIdentifieranyrequiredPattern: ^\S+$

clientSecretanyrequiredPattern: ^\S+$

Responses

application/json

objectoptional

application/json

post

POST /api/rest/application/{applicationNameOrId}/configuration/psn HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1403

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "npIdentifier": null,
  "clientSecret": null
}

{
  "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.

Available options:

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.

npIdentifieranyrequiredPattern: ^\S+$

clientSecretanyrequiredPattern: ^\S+$

Responses

application/json

objectoptional

application/json

put

PUT /api/rest/application/{applicationNameOrId}/configuration/psn/{applicationConfigurationNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 1403

{
  "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": {
          "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
        }
      ]
    }
  },
  "productBundles": [
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ],
      "metadata": null,
      "display": null
    }
  ],
  "npIdentifier": null,
  "clientSecret": null
}

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