Skip to main content
POST
Batch enable, pause, or delete

Authorizations

Authorization
string
header
required

GDELT Cloud API key. Send as Authorization: Bearer gdelt_sk_....

Body

application/json
ids
string<uuid>[]
required
Required array length: 1 - 100 elements
action
enum<string>
required
Available options:
enable,
disable,
pause,
resume,
delete

Response

Success

success
boolean
required

True when every unique submitted id resolved and the atomic operation completed. An idempotent no-op still resolves successfully.

requested
integer
required

Number of ids submitted, including duplicates.

Required range: 1 <= x <= 100
unique_ids
integer
required

Number of unique submitted ids processed.

Required range: 1 <= x <= 100
affected
integer
required

Number of unique Monitor ids that actually changed state or were deleted. Already-in-target-state no-ops are excluded.

Required range: 0 <= x <= 100
affected_ids
string<uuid>[]
required

Unique ids that actually changed state or were deleted, in first-submitted order.

Maximum array length: 100
not_found
string<uuid>[]
required

Unique submitted ids that were not found in the active organization.

Maximum array length: 100