v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB

Campaigns

Get all campaigns details

get/campaigns

Query parameters

campaignType'system-update' | 'software-update'

Example:system-update

Type of the campaigns we want

status'enabled' | 'disabled' | 'archived'

Example:enabled

Status of the campaigns we want

Response

Campaign details result

result'success' | 'error' required

Result of the request

action'allCampaigns' required

The id of the action

Example response

{
  "data": {
    "campaigns": [
      {
        "info": {
          "id": "0076a379-f32d-4732-9e91-33ab219d8fde",
          "name": "Update all systems",
          "schedule": {
            "start": {
              "hour": 17,
              "minute": 22
            },
            "end": {
              "hour": 3,
              "minute": 42
            },
            "tz": "Europe/Paris"
          }
        },
        "version": 2,
        "details": {
          "targets": [
            [
              {
                "include": {
                  "or": [
                    "special:all"
                  ]
                },
                "exclude": {
                  "or": [
                    "policyServer:root",
                    "group:cd377524-808b-4b42-8724-6ef308efeac7"
                  ]
                }
              }
            ]
          ]
        }
      }
    ]
  }
}