Applications

Searches application profiles

get

Searches all instances of ApplicationProfiles associated with the application. The search query may be a full text search.

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

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

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

Updates the ProductBundle

put

Updates the ProductBundle for the given ApplicationConfiguration

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationIdanyRequired

Body

anyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

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

[
  {
    "productId": null,
    "displayName": null,
    "description": null,
    "productBundleRewards": [
      {
        "itemId": null,
        "quantity": null
      }
    ],
    "metadata": null,
    "display": null
  }
]

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

Search Applications

get

Performs a full-text search of all applications known to the server. As with other full-text endpoints this allows for pagination and offset.

Authorizations

auth_bearersession_secret

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/application HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Creates a New Application

post

Gets the metadata for a single application. This may include more specific details not available in the bulk-get or fetch operation.

Authorizations

auth_bearersession_secret

Body

nameanyRequiredPattern: [^_]\w+

descriptionanyOptional

attributesanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/application HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": null,
  "description": null,
  "attributes": null
}

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

Get an Application

get

Gets the metadata for a single application. This may include more specific details not availble in the bulk-get or fetch operation.

Authorizations

auth_bearersession_secret

Path parameters

nameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/application/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Updates an Application

put

Performs an update to an existing application known to the server.

Authorizations

auth_bearersession_secret

Path parameters

nameOrIdanyRequired

Body

nameanyRequiredPattern: [^_]\w+

descriptionanyOptional

attributesanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/rest/application/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": null,
  "description": null,
  "attributes": null
}

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

Deletes an Application

delete

Deletes a specific application known to the server.

Authorizations

auth_bearersession_secret

Path parameters

nameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

*/*

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/application/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Creates a new Facebook ApplicationConfiguration

post

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

Authorizations

auth_bearersession_secret

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.

Possible values:

uniqueIdentifieranyOptional

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

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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"
}

Gets a Facebook Application Configuration

get

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

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

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

Updates a Facebook ApplicationConfiguration

put

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

Authorizations

auth_bearersession_secret

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.

Possible values:

uniqueIdentifieranyOptional

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

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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"
}

Deletes a Facebook ApplicationConfiguration

delete

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

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

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

Creates a new Firebase ApplicationConfiguration

post

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

Body

idanyOptional

The database assigned ID for the application configuration.

categoryundefined · enumRequired

The category for the application configuration.

Possible values:

uniqueIdentifieranyOptional

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

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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"
}

Gets a Firebase Application Configuration

get

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

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

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

Updates a Firebase ApplicationConfiguration

put

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Body

idanyOptional

The database assigned ID for the application configuration.

categoryundefined · enumRequired

The category for the application configuration.

Possible values:

uniqueIdentifieranyOptional

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

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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"
}

Deletes a Firebase ApplicationConfiguration

delete

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

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

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

Creates a new Google Play ApplicationConfiguration

post

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

Body

idanyOptional

The database assigned ID for the application configuration.

categoryundefined · enumRequired

The category for the application configuration.

Possible values:

uniqueIdentifieranyOptional

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

productBundlesanyOptional

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

applicationIdanyOptional

jsonKeyanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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"
}

Gets a Google Play Application Configuration

get

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

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

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

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Body

idanyOptional

The database assigned ID for the application configuration.

categoryundefined · enumRequired

The category for the application configuration.

Possible values:

uniqueIdentifieranyOptional

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

productBundlesanyOptional

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

applicationIdanyOptional

jsonKeyanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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"
}

Deletes a Google Play ApplicationConfiguration

delete

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/application/{applicationNameOrId}/configuration/google_play/{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

auth_bearersession_secret

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.

Possible values:

uniqueIdentifieranyOptional

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

productBundlesanyOptional

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

applicationIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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"
}

Gets a iOS Application Configuration

get

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

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

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

Updates a iOS ApplicationConfiguration

put

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

Authorizations

auth_bearersession_secret

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.

Possible values:

uniqueIdentifieranyOptional

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

productBundlesanyOptional

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

applicationIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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"
}

Deletes a iOS ApplicationConfiguration

delete

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/application/{applicationNameOrId}/configuration/ios/{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

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

Body

This configures the matchmaking system. More specifically, this configures which scripts andmethods will be called when a successful match has been made.

idanyOptional

The database assigned ID for the application configuration.

categoryundefined · enumRequired

The category for the application configuration.

Possible values:

uniqueIdentifieranyOptional

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

productBundlesanyOptional

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

schemeanyRequired

A user-sepecified unqiue identifier for the matching scheme. It is possible to specify multiple schemes per application, but each must be uniquely named. Each scheme allows for the specification of different scripts to handle the successful match. When requesting matchmaking services clients will specify the scheme to be used.

Pattern: [^_]\w+

algorithmundefined · enumRequired

Specifies the matching algorithm to use. Algorithms are builtin and implemented by the API services. Currently, only FIFO is supported.

Possible values:

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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
    }
  ],
  "scheme": null,
  "algorithm": "FIFO",
  "success": {
    "module": null,
    "method": null
  }
}

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

Deletes a iOS ApplicationConfiguration

delete

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

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

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

Updates a iOS ApplicationConfiguration

put

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Body

This configures the matchmaking system. More specifically, this configures which scripts andmethods will be called when a successful match has been made.

idanyOptional

The database assigned ID for the application configuration.

categoryundefined · enumRequired

The category for the application configuration.

Possible values:

uniqueIdentifieranyOptional

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

productBundlesanyOptional

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

schemeanyRequired

A user-sepecified unqiue identifier for the matching scheme. It is possible to specify multiple schemes per application, but each must be uniquely named. Each scheme allows for the specification of different scripts to handle the successful match. When requesting matchmaking services clients will specify the scheme to be used.

Pattern: [^_]\w+

algorithmundefined · enumRequired

Specifies the matching algorithm to use. Algorithms are builtin and implemented by the API services. Currently, only FIFO is supported.

Possible values:

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "category": "MATCHMAKING",
  "uniqueIdentifier": null,
  "parent": {
    "id": null,
    "name": null,
    "description": 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,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": {
          "id": null,
          "category": "MATCHMAKING",
          "uniqueIdentifier": null,
          "parent": {
            "id": null,
            "name": null,
            "description": 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
    }
  ],
  "scheme": null,
  "algorithm": "FIFO",
  "success": {
    "module": null,
    "method": null
  }
}

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

Gets a iOS Application Configuration

get

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

Authorizations

auth_bearersession_secret

Path parameters

applicationNameOrIdanyRequired

applicationConfigurationNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

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

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