Applications

PreviousElements 3.0.X (Preview)NextFriends and Followers

Searches application profiles

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

get

/application/{applicationNameOrId}/configuration

Authorizations

Path parameters

applicationNameOrIdanyrequired

Query parameters

offsetany · default: 0

countany · default: 20

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Updates the ProductBundle

Updates the ProductBundle for the given ApplicationConfiguration

put

/application/{applicationNameOrId}/configuration/{applicationConfigurationId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationIdanyrequired

Body

any

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/{applicationConfigurationId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '[
    {
      "productId": null,
      "displayName": null,
      "description": null,
      "display": null,
      "metadata": null,
      "productBundleRewards": [
        {
          "itemId": null,
          "quantity": null
        }
      ]
    }
  ]'

400

401

403

404

409

500

501

503

default

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

Search Applications

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

get

/application

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a New Application

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

post

/application

Authorizations

Body

descriptionany

nameanyrequired

Pattern: [^_]\w+

attributesany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/application' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": null,
    "name": null,
    "attributes": null
  }'

400

401

403

404

409

500

501

503

default

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

Get an Application

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

get

/application/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/application/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Updates an Application

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

put

/application/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Body

descriptionany

nameanyrequired

Pattern: [^_]\w+

attributesany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/application/{nameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": null,
    "name": null,
    "attributes": null
  }'

400

401

403

404

409

500

501

503

default

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

Deletes an Application

Deletes a specific application known to the server.

delete

/application/{nameOrId}

Authorizations

Path parameters

nameOrIdanyrequired

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Creates a new Facebook ApplicationConfiguration

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

post

/application/{applicationNameOrId}/configuration/facebook

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

applicationIdanyrequired

The AppID as it appears in the Facebook Developer Console

applicationSecretanyrequired

The App Secret as it appears in the Facebook Developer Console

categoryundefined · enumrequired

The category for the application configuration.

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

builtinApplicationPermissionsany

productBundlesany

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,
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "description": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "name": null,
      "applicationConfiguration": {
        "id": null,
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "category": "MATCHMAKING",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "display": null,
            "metadata": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ]
          }
        ]
      },
      "attributes": null
    },
    "applicationId": null,
    "applicationSecret": null,
    "category": "MATCHMAKING",
    "builtinApplicationPermissions": [],
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "display": null,
        "metadata": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ]
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Gets a Facebook Application Configuration

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

get

/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}

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

Updates a Facebook ApplicationConfiguration

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

put

/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

applicationIdanyrequired

The AppID as it appears in the Facebook Developer Console

applicationSecretanyrequired

The App Secret as it appears in the Facebook Developer Console

categoryundefined · enumrequired

The category for the application configuration.

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

builtinApplicationPermissionsany

productBundlesany

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,
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "description": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "name": null,
      "applicationConfiguration": {
        "id": null,
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "category": "MATCHMAKING",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "display": null,
            "metadata": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ]
          }
        ]
      },
      "attributes": null
    },
    "applicationId": null,
    "applicationSecret": null,
    "category": "MATCHMAKING",
    "builtinApplicationPermissions": [],
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "display": null,
        "metadata": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ]
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Deletes a Facebook ApplicationConfiguration

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

delete

/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}

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

Creates a new Firebase ApplicationConfiguration

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

post

/application/{applicationNameOrId}/configuration/firebase

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

projectIdanyrequired

The contents of the serviceAccountCredentials.json file.

serviceAccountCredentialsanyrequired

The contents of the serviceAccountCredentials.json file.

categoryundefined · enumrequired

The category for the application configuration.

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

productBundlesany

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,
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "description": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "name": null,
      "applicationConfiguration": {
        "id": null,
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "category": "MATCHMAKING",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "display": null,
            "metadata": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ]
          }
        ]
      },
      "attributes": null
    },
    "projectId": null,
    "serviceAccountCredentials": null,
    "category": "MATCHMAKING",
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "display": null,
        "metadata": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ]
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Gets a Firebase Application Configuration

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

get

/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}

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

Updates a Firebase ApplicationConfiguration

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

put

/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

projectIdanyrequired

The contents of the serviceAccountCredentials.json file.

serviceAccountCredentialsanyrequired

The contents of the serviceAccountCredentials.json file.

categoryundefined · enumrequired

The category for the application configuration.

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

productBundlesany

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,
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "description": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "name": null,
      "applicationConfiguration": {
        "id": null,
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "category": "MATCHMAKING",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "display": null,
            "metadata": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ]
          }
        ]
      },
      "attributes": null
    },
    "projectId": null,
    "serviceAccountCredentials": null,
    "category": "MATCHMAKING",
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "display": null,
        "metadata": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ]
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Deletes a Firebase ApplicationConfiguration

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

delete

/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}

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

Creates a new Google Play ApplicationConfiguration

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

post

/application/{applicationNameOrId}/configuration/google_play

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

applicationIdany

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

categoryundefined · enumrequired

The category for the application configuration.

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

jsonKeyany

productBundlesany

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 '{
    "applicationId": null,
    "id": null,
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "description": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "name": null,
      "applicationConfiguration": {
        "id": null,
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "category": "MATCHMAKING",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "display": null,
            "metadata": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ]
          }
        ]
      },
      "attributes": null
    },
    "category": "MATCHMAKING",
    "jsonKey": null,
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "display": null,
        "metadata": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ]
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Gets a Google Play Application Configuration

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

get

/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}

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

Updates a Google Play ApplicationConfiguration

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

put

/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

applicationIdany

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

categoryundefined · enumrequired

The category for the application configuration.

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

jsonKeyany

productBundlesany

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 '{
    "applicationId": null,
    "id": null,
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "description": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "name": null,
      "applicationConfiguration": {
        "id": null,
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "category": "MATCHMAKING",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "display": null,
            "metadata": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ]
          }
        ]
      },
      "attributes": null
    },
    "category": "MATCHMAKING",
    "jsonKey": null,
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "display": null,
        "metadata": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ]
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Deletes a Google Play ApplicationConfiguration

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

delete

/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}

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

Creates a new iOS ApplicationConfiguration

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

post

/application/{applicationNameOrId}/configuration/ios

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

applicationIdanyrequired

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

categoryundefined · enumrequired

The category for the application configuration.

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

productBundlesany

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 '{
    "applicationId": null,
    "id": null,
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "description": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "name": null,
      "applicationConfiguration": {
        "id": null,
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "category": "MATCHMAKING",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "display": null,
            "metadata": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ]
          }
        ]
      },
      "attributes": null
    },
    "category": "MATCHMAKING",
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "display": null,
        "metadata": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ]
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Gets a iOS Application Configuration

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

get

/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}

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

Updates a iOS ApplicationConfiguration

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

put

/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

applicationIdanyrequired

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

categoryundefined · enumrequired

The category for the application configuration.

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

productBundlesany

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 '{
    "applicationId": null,
    "id": null,
    "uniqueIdentifier": null,
    "parent": {
      "id": null,
      "description": null,
      "scriptRepoUrl": null,
      "httpDocumentationUrl": null,
      "httpDocumentationUiUrl": null,
      "httpTunnelEndpointUrl": null,
      "name": null,
      "applicationConfiguration": {
        "id": null,
        "uniqueIdentifier": null,
        "parent": "[Circular Reference]",
        "category": "MATCHMAKING",
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "display": null,
            "metadata": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ]
          }
        ]
      },
      "attributes": null
    },
    "category": "MATCHMAKING",
    "productBundles": [
      {
        "productId": null,
        "displayName": null,
        "description": null,
        "display": null,
        "metadata": null,
        "productBundleRewards": [
          {
            "itemId": null,
            "quantity": null
          }
        ]
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Deletes a iOS ApplicationConfiguration

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

delete

/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}

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

Creates a new iOS ApplicationConfiguration

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

post

/application/{applicationNameOrId}/configuration/matchmaking

Authorizations

Path parameters

applicationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

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+

successobjectrequired

Defines a script method and a module to invoke.

categoryundefined · enumrequired

The category for the application configuration.

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

algorithmundefined · enumrequired

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

Options: FIFO

productBundlesany

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Deletes a iOS ApplicationConfiguration

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

delete

/application/{applicationNameOrId}/configuration/matchmaking/{applicationConfigurationNameOrId}

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/matchmaking/{applicationConfigurationNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Updates a iOS ApplicationConfiguration

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

put

/application/{applicationNameOrId}/configuration/matchmaking/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Body

idany

The database assigned ID for the application configuration.

uniqueIdentifierany

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

parentobjectrequired

schemeanyrequired

Pattern: [^_]\w+

successobjectrequired

Defines a script method and a module to invoke.

categoryundefined · enumrequired

The category for the application configuration.

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

algorithmundefined · enumrequired

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

Options: FIFO

productBundlesany

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Gets a iOS Application Configuration

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

get

/application/{applicationNameOrId}/configuration/matchmaking/{applicationConfigurationNameOrId}

Authorizations

Path parameters

applicationNameOrIdanyrequired

applicationConfigurationNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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