Application groups

Version date: 22 April 2025

To authorize, you need to add the header "Authorization: Bearer ..." (get your API KEY in your personal account on "Personal" tab).

Endpoints

Create an Application Group

POST https://core.push.express/api/b/v2/app/groups

  • Description: Creates a new application group.

Request:

curl --url "https://core.push.express/api/b/v2/app/groups"
    --request POST
    --header "content-type: application/json"
    --header "Authorization: Bearer ..."
    --data '
{
    "app_ids": [25328,25329,25330,25331],
    "name": "appGroupName",
    "all_apps": false,
'

Body params:

  • app_ids, required. If all_apps = flash, you will definitely need to send the application ID.

  • name, required. Application group name, any printable characters.

  • all_apps, required. If true, the group will consist of all active applications. In this case, the app_ids parameter can be left empty..

Response:

  • 201: New application group created

{"id":12345}

  • id, int. ID of newly created application group.

List Application Groups

GET https://core.push.express/api/b/v2/app/groups

  • Description: Retrieves a list of all application groups

No more then 10000 records can be returned

Request

curl --url "https://core.push.express/api/b/v2/app/groups?archived=false"
    --request GET
    --header "Authorization: Bearer ..."

Query parameters:

  • archived, bool, optional. Filters archived application groups if true, otherwise returns active application groups.

Response:

  • 200: List of application groups retrieved

[
    {
        "id": 1443,
        "app_ids": [25328,25329,25330,25331],
        "name": "appGroupName",
        "all_apps": false,
        "archived": false
    },
    ...
]

  • id, int. ID of application group for API.

  • app_ids, string. ID of applications in group.

  • name, all_apps see Create an Application Group.

  • archived, bool. True if application group archived, false otherwise.

Get an Application Group

GET https://core.push.express/api/b/v2/app/groups/:app_group_id

  • Description: Retrieves details of a specific application group by its ID.

Request

curl --url "https://core.push.express/api/b/v2/app/groups/:app_group_id"
    --request GET
    --header "Authorization: Bearer ..."

Response:

  • 200: Application group info retrieved

{
    "id": 1443,
    "app_ids": [25328,25329,25330,25331],
    "name": "appGroupName",
    "all_apps": false,
    "archived": false
}

Details on response can see in List Application Groups

Archive an Application Group

POST https://core.push.express/api/b/v2/app/groups/:app_group_id/archive

  • Description: Archives a specific application group by its ID. This actions is idempotent, i.e. double archiving is valid.

Request

curl --url "https://core.push.express/api/b/v2/app/groups/:app_group_id/archive"
    --request POST
    --header "Authorization: Bearer ..."

Response:

  • 204: No content

Delete an Application Group

DELETE https://core.push.express/api/b/v2/app/groups/:app_group_id

  • Description: Deletes a specific application group by its ID.

Request

curl --url "https://core.push.express/api/b/v2/app/groups/:app_group_id/archive"
    --request DELETE
    --header "Authorization: Bearer ..."

Response:

  • 204: No content

If an application group has successfully been deleted then it was automatically removed from all schedulers.

Restore an Application Group

POST https://core.push.express/api/b/v2/apps/:app_group_id/unarchive

  • Description: Restores a specific application group by its ID. This actions is idempotent, i.e. double unarchiving is valid.

Request

curl --url "https://core.push.express/api/b/v2/app/groups/:app_group_id/unarchive"
    --request POST
    --header "Authorization: Bearer ..."

Response:

  • 204: No content

Update an Application Group

PUT https://core.push.express/api/b/v2/app/groups/:app_group_id

  • Description: Updates the base information of a specific app by its ID.

Request:

curl --url "https://core.push.express/api/b/v2/app/groups/:app_group_id"
    --request PUT
    --header "content-type: application/json"
    --header "Authorization: Bearer ..."
    --data '
{
    "app_ids": [25329,25330],
    "name": "test",
    "all_apps": false
}
'

Response:

  • 204: No content

Error handling

All HTTP response codes 2xx SHOULD be considered as success. Requested action was executed successfully.

All HTTP response codes above 400 MUST be considered as error. Requested action failed. Retries policy should be hold according to HTTP specification.

Common API errors:

  • 400 - request error. Request has invalid data. Check you request (url, headers, payload)

  • 401 is returned when provided API token is invalid. Check your authentification data.

  • 404 is returned when resource doesn't exist. Check your request data.

    Example: PUT https://core.push.express/api/b/v2/app/groups/:app_group_id returns 404 when provided app_group_id doesn't exist

  • All HTTP response codes 5xx - other errors from proxy servers, load balancers, etc. There may or may not have some explanation in response body. These errors always require retries.

API errors have content-type: application/json header and json response body

Example: {"error": "validation error: ...", "req_id":"<string>"}

Response parameters:

  • req_id string is a request ID. It is used by support for problem solving, please, provide it to support if problem emerged.

  • error object, describing errors.

Non-API errors like 502, 504, etc., may or may not include a description.

PreviousApplicationsNextApp Instances (Devices)

Last updated