Introduction

The Zaap API allows you to manage your Apps and resources in a simple, programmatic way using conventional HTTP requests.

All of the functionality that you are familiar with in the Zaap control panel is also available through the API, allowing you to script the complex actions that your situation requires.

Authentication

In order to interact with the DigitalOcean API, you or your application must authenticate.

The Zaap API handles this with an API Key that you can find in your settings of your account.

Because of this, it is absolutely essential that you keep your API Key secure.

In order to make an authenticated request, include a Authorization header containing your API Key. All requests must be made over HTTPS.

Authenticate with an Authorization Header

curl -X $HTTP_METHOD -H "Authorization: Bearer $api_key" "<https://api.digitalocean.com/v2/$OBJECT>"

List All Apps

List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app.

• Authorization

GET /v1/apps

Request samples

curl <https://app.zaap.sh/api/v1/apps> \\
	-H "Authorization: $ZAAP_API_KEY"'

Response samples

{
  "apps": [
    {
      "id": "bc35fdff-6502-46e8-920b-b6d643f7c3b2",
      "name": "My app",
      "platforms": [
        "ios",
        "android"
      ],
      "website_url": "google.com",
      "created_at": "2021-08-11T16:40:36.727+02:00",
      "updated_at": "2021-08-16T14:50:47.262+02:00"
    },
		...
  ]
}

Retrieve an Existing App

Retrieve details about an existing app by its ID. Information about the current active deployment as well as any in progress ones will also be included in the response.

• Authorization

• Path parameters

GET /v1/apps/:app_id

Request samples

curl <https://app.zaap.sh/api/v1/apps/{app_id}> \\
	-H "Authorization: $ZAAP_API_KEY"

Response samples

{
  "app": {
    "id": "bc35fdff-6502-46e8-920b-b6d643f7c3b2",
    "name": "My app",
    "platforms": [
      "ios",
      "android"
    ],
    "website_url": "google.com",
    "created_at": "2021-08-11T16:40:36.727+02:00",
    "updated_at": "2021-08-16T14:50:47.262+02:00"
  }
}

List App Notifications

List all notifications of an app.

• Authorization

• Path parameters

GET /v1/apps/:app_id/notifications

Request samples

curl <https://app.zaap.sh/api/v1/apps/{app_id}/notifications> \\
	-H "Authorization: $ZAAP_API_KEY"

Response samples

{
  "pagination": {
    "count": 17,
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1
  },
  "notifications": [
    {
      "id": "f82e96da-a426-4f10-836e-0b6df0628a5e",
      "title": "Test notification",
      "message": "My test notification",
      "status": "sent",
      "app_id": "bc35fdff-6502-46e8-920b-b6d643f7c3b2",
      "scheduled_at": null,
      "include_external_ids": [],
      "include_installation_ids": [
        "c3ffdc43-b4c4-4262-9191-18a8dddcaeb3",
        "2c04c2b7-8552-4e46-801e-8c31961ca04d"
      ],
      "created_at": "2021-08-29T23:16:47.438+02:00",
      "updated_at": "2021-08-29T23:16:57.235+02:00"
    },
		...
	]
}